-
Notifications
You must be signed in to change notification settings - Fork 541
8291906: Bindings.createXxxBinding inherit incorrect method docs #881
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
8291906: Bindings.createXxxBinding inherit incorrect method docs #881
Conversation
|
👋 Welcome back nlisker! A progress list of the required criteria for merging this PR into |
kevinrushforth
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I can tell, none of these are public API and so don't show up in the docs. (If they were, then the lack of an @return in a few places would generate a warning which we are not seeing. Are you building the docs with a setting that produces docs for non-public classes?
If that's the reason for doing this, then it probably doesn't need to go into 19 (although, since we are going to generate the docs again anyway., I won't object).
|
I don't mind either way. I initially bundled it with the issue for fixing API docs, but decoupled it later and just thought it would be fine to do them both. The changes are very straightforward.
No, but Eclipse shows internal docs also. I suspect other IDEs do so as well. |
kevinrushforth
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine. I left a question about the missing @return tags, but it might not matter here depending on whether the IDEs care.
|
@nlisker 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: 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 no new commits pushed to the ➡️ To integrate this PR with the above commit message to the |
|
/integrate |
|
Going to push as commit 5c00783. |
Added docs for inherited methods in
Bindingssubclasses.Progress
Issue
Reviewers
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.org/jfx pull/881/head:pull/881$ git checkout pull/881Update a local copy of the PR:
$ git checkout pull/881$ git pull https://git.openjdk.org/jfx pull/881/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 881View PR using the GUI difftool:
$ git pr show -t 881Using diff file
Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/881.diff