[jfx15] RFR: 8246343: Fix mistakes in FX API docs [v3]

Kevin Rushforth kcr at openjdk.java.net
Mon Jul 27 17:36:55 UTC 2020

On Sun, 26 Jul 2020 10:10:09 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

>> Fixes https://bugs.openjdk.java.net/browse/JDK-8246343 and some additional fixes in the vicinity.
> Nir Lisker has updated the pull request incrementally with one additional commit since the last revision:
>   VBox and HBox fixes

A few inline comments, but otherwise looks fine.

modules/javafx.controls/src/main/java/javafx/scene/control/Cell.java line 599:

> 598:     /**
> 599:      * Commits an edit to the value of the cell.
> 600:      * Call this function when appropriate (based on the user interaction requirements

A similar change could be made to `startEdit` and `cancelEdit` in the same class.

modules/javafx.controls/src/main/java/javafx/scene/control/Cell.java line 615:

> 614:      * implementations - it should be sufficient to simply call this method
> 615:      * when appropriate (e.g., when the user pressed the Enter key, you may do something
> 616:      * like {@code cell.commitEdit(converter.fromString(textField.getText()));}</p>

Since you are changing this, perhaps you might also fix the one in the previous paragraph as well -- the one in the
`<ol>` ... `</ol>` block?

modules/javafx.graphics/src/main/java/javafx/scene/layout/HBox.java line 245:

> 244:     /**
> 245:      * Creates an {@code HBox} layout with{@code spacing = 0}.
> 246:      * @param children the initial set of children for this pane

missing a space between `with` and `{@code`

modules/javafx.graphics/src/main/java/javafx/scene/layout/VBox.java line 163:

> 162:      * If no vertical grow priority is set on a child, the vbox will never
> 163:      * allocate it additional vertical space, if available.
> 164:      * <p>

This isn't a new problem, but the following is awkward:

"If no vertical grow priority is set on a child, the vbox will never allocate it additional vertical space, if

If this is trying to say that the vbox will never allocate extra space for that child, then it should be reworded
slightly. Maybe something like this?

"If no vertical grow priority is set on a child, the vbox will never allocate any additional vertical space for that

I note that HBox has the same awkward sentence.

modules/javafx.graphics/src/main/java/javafx/scene/layout/HBox.java line 175:

> 174:      * allocate it additional horizontal space if available.
> 175:      * <p>
> 176:      * Setting the value to {@code null} will remove the constraint.

See comment in VBox that applies to this section as well.


PR: https://git.openjdk.java.net/jfx/pull/274

More information about the openjfx-dev mailing list