JDK-8246343 : Fix mistakes in FX API docs
  • Type: Bug
  • Component: javafx
  • Sub-Component: other
  • Affected Version: openjfx14
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2020-06-02
  • Updated: 2020-07-31
  • Resolved: 2020-07-29
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
Other
openjfx15Fixed
Related Reports
Duplicate :  
JDK-8244820 - JavaDoc has wrong description for the value parameter of VBox.setVgrow
Relates :  
JDK-8250590 - Classes and methods in the javafx.css package are missing documentation
Description
Issue for collecting API doc fixes for OpenJFX15:

1. VBox constructor : "spacing - the amount of horizontal space between each child" -- should be vertical

2. VBox#setVgrow : "value - the horizontal grow priority for the child" -- should be vertical
(see JDK-8244820)

3. introduction_to_fxml.html : "attribute that points to a handler method with a ListChangeListner.Change" -- should be "ListChangeListener"

4. Text#fontSmoothingTypeProperty : "The width of the bounding box is defined by the widest row." -- sentence should be removed (looks like a copy/paste error)

5. Cell#commitEdit���(T newValue) : first sentence (summary) description is broken

6. In the pakage javafx.css [1], some classes in and their methods are missing docs (deferred to JDK-8250590)

7. Transition: "In addition an extending class" missing a comma

[1] https://openjfx.io/javadoc/14/javafx.graphics/javafx/css/package-summary.html
Comments
Changeset: 487854cb Author: Nir Lisker <nlisker@openjdk.org> Date: 2020-07-29 09:41:54 +0000 URL: https://git.openjdk.java.net/jfx/commit/487854cb
29-07-2020
Thanks. You can split #6 into its own bug if needed.
02-06-2020
This is fine. I added a couple of items, though I don't think I'll be able to do #6 as I'm not familiar with the API.
02-06-2020
[~nlisker] if you are willing to fix this, that would be appreciated. Otherwise, go ahead and assign it back to me.
02-06-2020