[jfx15] RFR: 8250799: NumberStringConverter and its subclasses are missing documentation for all their constructors [v3]

Kevin Rushforth kcr at openjdk.java.net
Fri Aug 7 13:02:04 UTC 2020

On Thu, 30 Jul 2020 16:42:00 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

>> This was missed the in Javadoc fixes for 15.
>> Added documentation for all the constructors, did a bit of formatting, and removed redundant comments.
> Nir Lisker has updated the pull request incrementally with one additional commit since the last revision:
>   Corrected NumberFormat constructor text

modules/javafx.base/src/main/java/javafx/util/converter/CurrencyStringConverter.java line 35:

> 34: /**
> 35:  * A {@link StringConverter} implementation for {@link Number} values that represent currency. Instances of this
> class are immutable. 36:  *

Given that there are no setters or other mutator methods, the immutability seems obvious. I don't see a problem with
stating it explicitly, though. It's up to you.

modules/javafx.base/src/main/java/javafx/util/converter/CurrencyStringConverter.java line 52:

> 51:     /**
> 52:      * Constructs a {@code CurrencyStringConverter} with the given locale and the default format.
> 53:      */

Can you also add the `@param locale` tag? This applies to all of the newly documented constructors that have arguments.


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

More information about the openjfx-dev mailing list