[jfx20] RFR: 8293587: Fix mistakes in FX API docs

[John Hendrikx]

On Mon, 6 Feb 2023 23:00:17 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

> Fixes and cleanup in the areas in the linked issue.

Looks good to me, I added some more minor suggestions as well.

modules/javafx.controls/src/main/java/javafx/scene/control/ListView.java line 467:

> 465:     /**
> 466:      * The {@code Node} to show to the user when the {@code ListView} has no content to show.
> 467:      * This happens when the table model has no data or when a filter has been applied to the list model, resulting in

Suggestion:

     * This happens when the list model has no data or when a filter has been applied to the list model, resulting in

modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java line 62:

> 60: 
> 61: /**
> 62:  * A special layout designed to lay out rich text.

What's "special" about it? :-)
Suggestion:

 * A layout designed to lay out rich text.

modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java line 81:

> 79:  * width in the {@code Text} node is ignored since the width used for wrapping
> 80:  * is the {@code TextFlow}'s width. The value of the {@code pickOnBounds} property
> 81:  * of a {@code Text} is set to {@code false} when it is laid out by the

Suggestion:

 * of a {@code Text} node is set to {@code false} when it is laid out by the

modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java line 83:

> 81:  * of a {@code Text} is set to {@code false} when it is laid out by the
> 82:  * {@code TextFlow}. This happens because the content of a single {@code Text} node can be
> 83:  * divided and placed in different locations in the {@code TextFlow} (usually due to

Suggestion:

 * split and placed in different locations in the {@code TextFlow} (usually due to

modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java line 90:

> 88:  * It can be specified by the application by setting the {@code TextFlow}'s preferred
> 89:  * width. If no wrapping is desired, the application can either set the preferred
> 90:  * with to {@code Double.MAX_VALUE} or {@code Region.USE_COMPUTED_SIZE}.

Should these be links?  They're the first mention in this doc.

modules/javafx.graphics/src/main/java/javafx/scene/text/TextFlow.java line 133:

> 131:  * <td>top/bottom insets plus the height of the text content</td></tr>
> 132:  * <tr><th scope="row">maximum</th>
> 133:  * <td>Double.MAX_VALUE</td><td>Double.MAX_VALUE</td></tr>

Suggestion:

 * <td>{@code Double.MAX_VALUE}</td><td>{@code Double.MAX_VALUE}</td></tr>

-------------

Marked as reviewed by jhendrikx (Committer).

PR: https://git.openjdk.org/jfx/pull/1025