Navigation Menu

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

8291906: Bindings.createXxxBinding inherit incorrect method docs #881

Conversation

nlisker
Copy link
Collaborator

@nlisker nlisker commented Aug 19, 2022

Added docs for inherited methods in Bindings subclasses.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8291906: Bindings.createXxxBinding inherit incorrect method docs

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jfx pull/881/head:pull/881
$ git checkout pull/881

Update a local copy of the PR:
$ git checkout pull/881
$ git pull https://git.openjdk.org/jfx pull/881/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 881

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jfx/pull/881.diff

@nlisker nlisker marked this pull request as ready for review August 19, 2022 00:18
@bridgekeeper
Copy link

bridgekeeper bot commented Aug 19, 2022

👋 Welcome back nlisker! A progress list of the required criteria for merging this PR into jfx19 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 Aug 19, 2022
@mlbridge
Copy link

mlbridge bot commented Aug 19, 2022

Webrevs

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.

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).

@nlisker
Copy link
Collaborator Author

nlisker commented Aug 20, 2022

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.

Are you building the docs with a setting that produces docs for non-public classes?

No, but Eclipse shows internal docs also. I suspect other IDEs do so as well.

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.

Looks fine. I left a question about the missing @return tags, but it might not matter here depending on whether the IDEs care.

@openjdk
Copy link

openjdk bot commented Aug 20, 2022

@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:

8291906: Bindings.createXxxBinding inherit incorrect method docs

Reviewed-by: 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 no new commits pushed to the jfx19 branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

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

@openjdk openjdk bot added the ready Ready to be integrated label Aug 20, 2022
@nlisker
Copy link
Collaborator Author

nlisker commented Aug 20, 2022

/integrate

@openjdk
Copy link

openjdk bot commented Aug 20, 2022

Going to push as commit 5c00783.

@openjdk openjdk bot added the integrated Pull request has been integrated label Aug 20, 2022
@openjdk openjdk bot closed this Aug 20, 2022
@openjdk openjdk bot removed ready Ready to be integrated rfr Ready for review labels Aug 20, 2022
@openjdk
Copy link

openjdk bot commented Aug 20, 2022

@nlisker Pushed as commit 5c00783.

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

@nlisker nlisker deleted the 8291906_Bindings.createXxxBinding_inherit_incorrect_method_docs branch August 20, 2022 00:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated
2 participants