[jfx19] RFR: 8286678: Fix mistakes in FX API docs [v2]

Mon Aug 22 22:32:41 UTC 2022

On Fri, 19 Aug 2022 00:37:34 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

>> Fixes the mistakes in the JBS ticket and some additional minor corrections.
>
> Nir Lisker has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Fix typo

A few comments inline.

modules/javafx.controls/src/main/java/javafx/scene/control/TextFormatter.java line 47:

> 45:  * </ul>
> 46:  * <p>
> 47:  * It's possible to have a formatter with just filter or value converter. If value converter is not provided however,

The "however" in the middle of the sentence is a bit awkward, and not really needed here. I suggest dropping it.

modules/javafx.controls/src/main/java/javafx/scene/control/TextFormatter.java line 48:

> 46:  * <p>
> 47:  * It's possible to have a formatter with just filter or value converter. If value converter is not provided however,
> 48:  * setting a value will result in an {@code IllegalStateException} and the value is always {#code null}.

That should be `{@code null}`

modules/javafx.graphics/src/main/java/javafx/concurrent/ScheduledService.java line 130:

> 128:  * will treat that duration as if it were Duration.ZERO. Likewise, any Duration which answers true
> 129:  * to {@link javafx.util.Duration#isIndefinite()} will be treated as if it were a duration of Double.MAX_VALUE
> 130:  * milliseconds. Any {@code null} Duration is treated as Duration.ZERO. Any custom implementation of a backoff strategy

Since you changed `null` to use code style, maybe also do it for `Duration.ZERO`?

modules/javafx.graphics/src/main/java/javafx/concurrent/Service.java line 102:

> 100:  *     Because a Service is intended to simplify declarative use cases, subclasses
> 101:  *     should expose as properties the input parameters to the work to be done.
> 102:  *     For example, suppose I wanted to write a Service that reads the first line

As long as you are changing this sentence, can you also change `I` to `you`? The unintended use of first person here is a bit jarring.

modules/javafx.graphics/src/main/java/javafx/concurrent/package.html line 36:

> 34: </head>
> 35: <body>
> 36: <p>Provides the set of classes for javafx.concurrent.</p>

Can you make this same change to the page title?

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

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