8286678: Fix mistakes in FX API docs

[nlisker]

Fixes the mistakes in the JBS ticket and some additional minor corrections.

---

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-8286678: Fix mistakes in FX API docs

Reviewers

• Andy Goryachev (@andy-goryachev-oracle - Author) 🔄 Re-review required (review applies to d8ccb5ae)
• Kevin Rushforth (@kevinrushforth - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 880

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

Using diff file

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

[bridgekeeper]

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

[mlbridge]

Webrevs

• 04: Full - Incremental (c537fa93)
• 03: Full - Incremental (e9df3a27)
• 02: Full - Incremental (6e9eda88)
• 01: Full - Incremental (d8ccb5ae)
• 00: Full (6f2894de)

[andy-goryachev-oracle]

Would these changes require a CSR? Or, since they are just corrections, the API did not really change?
Otherwise, looks good. Thank you for cleaning up the docs!

[nlisker]

Would these changes require a CSR? Or, since they are just corrections, the API did not really change? Otherwise, looks good. Thank you for cleaning up the docs!

Usually they don't since there are no spec changes.

[kevinrushforth]

I took a quick look and don't see anything that would warrant a CSR. I'll confirm when I review.

[kevinrushforth]

A few comments inline.

[nlisker]

When looking at Service I noticed that in Worker the property docs are on the get methods instead of on the property methods: https://openjfx.io/javadoc/18/javafx.graphics/javafx/concurrent/Worker.html#getState()

This causes Service to inherit these as well. Docs should only appear on the property (except in special circumstances), but I didn't want to touch all of this here. Should I create a new issue for this or is it not worth it?

[kevinrushforth]

When looking at Service I noticed that in Worker the property docs are on the get methods instead of on the property methods ...

This causes Service to inherit these as well. Docs should only appear on the property (except in special circumstances), but I didn't want to touch all of this here. Should I create a new issue for this or is it not worth it?

I recommend to file a new issue. We can target it for JavaFX 20.

[kevinrushforth]

Looks good with one optional suggestion.

[kevinrushforth]

One more thing I noticed: "contains a value which" could be changed to "contains a value that"

[openjdk]

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

8286678: Fix mistakes in FX API 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 1 new commit pushed to the jfx19 branch:

• 5c00783: 8291906: Bindings.createXxxBinding inherit incorrect method docs

Please see this link for an up-to-date comparison between the source branch of this pull request and the jfx19 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 jfx19 branch, type /integrate in a new comment.

[nlisker]

/integrate

[openjdk]

@nlisker This pull request has not yet been marked as ready for integration.

[nlisker]

/integrate

[openjdk]

Going to push as commit 8b96776.
Since your change was applied there has been 1 commit pushed to the jfx19 branch:

• 5c00783: 8291906: Bindings.createXxxBinding inherit incorrect method docs

Your commit was automatically rebased without conflicts.

[openjdk]

@nlisker Pushed as commit 8b96776.

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