Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

8271091: Missing API docs in UI controls classes #646

Closed
wants to merge 5 commits into from
Closed

8271091: Missing API docs in UI controls classes #646

wants to merge 5 commits into from

Conversation

aghaisas
Copy link
Collaborator

@aghaisas aghaisas commented Oct 20, 2021 •
edited by openjdk bot

This PR fixes javadoc warnings in javafx.controls and javafx.web modules.
Note :

  • The javadoc needs to be generated with the JDK 18 EA build.
  • 2 javadoc warnings in javafx.controls TabPane class will be fixed under - JDK-8271085
  • There are still 20 javadoc warnings remaining in javafx.controls module and 3 warnings remaining in javafx.web module. The root cause is different and they will be addressed under JDK-8270996

Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jfx pull/646/head:pull/646
$ git checkout pull/646

Update a local copy of the PR:
$ git checkout pull/646
$ git pull https://git.openjdk.java.net/jfx pull/646/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 646

View PR using the GUI difftool:
$ git pr show -t 646

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jfx/pull/646.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Oct 20, 2021

👋 Welcome back aghaisas! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr Ready for review label Oct 20, 2021
@mlbridge
Copy link

mlbridge bot commented Oct 20, 2021 •
edited

Webrevs

nlisker
nlisker reviewed Oct 20, 2021
View reviewed changes
Copy link
Collaborator

@nlisker nlisker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Took a quick look at the new docs. I didn't check the resulting HTML or the corrected of the description, just format and grammar.

modules/javafx.controls/src/main/java/javafx/scene/chart/AreaChart.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/CheckMenuItem.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/Control.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/DateCell.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/MultipleSelectionModelBase.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/SortEvent.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/skin/TableViewSkinBase.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/skin/TextInputControlSkin.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/skin/VirtualContainerBase.java Outdated Show resolved Hide resolved
@kevinrushforth
Copy link
Member

/reviewers 2

@openjdk
Copy link

openjdk bot commented Oct 20, 2021

@kevinrushforth
The number of required reviews for this PR is now set to 2 (with at least 1 of role reviewers).

kevinrushforth
kevinrushforth reviewed Oct 22, 2021
View reviewed changes
Copy link
Member

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments below.

modules/javafx.controls/src/main/java/javafx/scene/control/DatePicker.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/MultipleSelectionModelBase.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/SortEvent.java Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/SortEvent.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/SortEvent.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/skin/TextInputControlSkin.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/skin/TextInputControlSkin.java Outdated Show resolved Hide resolved
modules/javafx.web/src/main/java/javafx/scene/web/HTMLEditorSkin.java Outdated Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java Show resolved Hide resolved
modules/javafx.web/src/main/java/javafx/scene/web/HTMLEditorSkin.java Outdated Show resolved Hide resolved
@kevinrushforth kevinrushforth mentioned this pull request Oct 22, 2021
Closed
3 tasks
kevinrushforth
kevinrushforth reviewed Oct 25, 2021
View reviewed changes
Copy link
Member

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Two minor comments. The rest looks great.

modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java Show resolved Hide resolved
modules/javafx.controls/src/main/java/javafx/scene/control/TabPane.java Outdated Show resolved Hide resolved
@aghaisas
Copy link
Collaborator Author

@nlisker, can you please take a look and approve?

kevinrushforth
kevinrushforth requested changes Oct 28, 2021
View reviewed changes
Copy link
Member

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doc changes look good. Please revert the access modifier change.

modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java Show resolved Hide resolved
kevinrushforth
kevinrushforth approved these changes Oct 28, 2021
View reviewed changes
Copy link
Member

@kevinrushforth kevinrushforth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. I confirmed that the implicit constructor for PopupControl.CSSBridge is protected in JavaFX 17, so making the explicitly added contructor be protected is correct.

nlisker
nlisker approved these changes Oct 29, 2021
View reviewed changes
Copy link
Collaborator

@nlisker nlisker left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't check the generated HTML pages or the correctness of the docs with respect to the functionality of their methods, but the docs themselves look good.

@openjdk
Copy link

openjdk bot commented Oct 29, 2021

@aghaisas This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8271091: Missing API docs in UI controls classes

Reviewed-by: nlisker, kcr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 5 new commits pushed to the master branch:

  • 717cfdc: 8274669: Dialog sometimes ignores max height
  • d244b30: 8275815: OCA link in README.md and CONTRIBUTING.md is broken
  • 28e8684: 8272638: Update copyright header for files modified in 2021
  • 7be0abb: 8274413: FX: Update copyright year in docs, readme files to 2022
  • a118d33: 8236689: macOS 10.15 Catalina: LCD text renders badly

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Ready to be integrated label Oct 29, 2021
@aghaisas
Copy link
Collaborator Author

/integrate

@openjdk
Copy link

openjdk bot commented Oct 29, 2021

Going to push as commit a947405.
Since your change was applied there have been 6 commits pushed to the master branch:

  • e7a106f: 8271090: Missing API docs in scenegraph classes
  • 717cfdc: 8274669: Dialog sometimes ignores max height
  • d244b30: 8275815: OCA link in README.md and CONTRIBUTING.md is broken
  • 28e8684: 8272638: Update copyright header for files modified in 2021
  • 7be0abb: 8274413: FX: Update copyright year in docs, readme files to 2022
  • a118d33: 8236689: macOS 10.15 Catalina: LCD text renders badly

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Oct 29, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Ready to be integrated rfr Ready for review labels Oct 29, 2021
@openjdk
Copy link

openjdk bot commented Oct 29, 2021

@aghaisas Pushed as commit a947405.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mstr2 mstr2 mstr2 left review comments

@kevinrushforth kevinrushforth kevinrushforth approved these changes

@nlisker nlisker nlisker approved these changes

Assignees
No one assigned
Labels
integrated Pull request has been integrated
Milestone
No milestone
4 participants
@aghaisas @kevinrushforth @nlisker @mstr2