RFR: 8271091: Missing API docs in UI controls classes [v4]
Nir Lisker
nlisker at openjdk.java.net
Wed Oct 27 16:37:29 UTC 2021
On Tue, 26 Oct 2021 06:24:35 GMT, Ajit Ghaisas <aghaisas at openjdk.org> wrote:
>> This PR fixes javadoc warnings in javafx.controls and javafx.web modules.
>> Note :
>> - The javadoc needs to be generated with the JDK 18 EA build.
>> - 2 javadoc warnings in javafx.controls TabPane class will be fixed under - [JDK-8271085](https://bugs.openjdk.java.net/browse/JDK-8271085)
>> - There are still 20 javadoc warnings remaining in javafx.controls module and 3 warnings remaining in javafx.web module. The root cause is different and they will be addressed under [JDK-8270996](https://bugs.openjdk.java.net/browse/JDK-8270996)
>
> Ajit Ghaisas has updated the pull request incrementally with one additional commit since the last revision:
>
> fix review comments
modules/javafx.controls/src/main/java/javafx/scene/control/CheckMenuItem.java line 89:
> 87: **************************************************************************/
> 88: /**
> 89: * Constructs a default {@code CheckMenuItem}.
`Label` uses "Creates an empty label" for the default constructor because it has no text or graphic. Maybe it's more informative that way.
modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java line 180:
> 178: * variable contains style properties and values and not the
> 179: * selector portion of a style rule.
> 180: * A value of {@code null} is implicitly converted to an empty {@code String}.
Maybe this line should be in a new line/paragraph.
modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java line 183:
> 181: *
> 182: * @return the {@code style} property
> 183: * @defaultValue null
`{@code null}`
modules/javafx.controls/src/main/java/javafx/scene/control/PopupControl.java line 1133:
> 1131: */
> 1132: public CSSBridge() {
> 1133: }
Looking at the [docs for 17](https://openjfx.io/javadoc/17/javafx.controls/javafx/scene/control/PopupControl.CSSBridge.html), the constructor there is `protected`, here it's `public`. Was this changed recently? If it's supposed to be `protected`, then the constructor is for subclasses.
modules/javafx.controls/src/main/java/javafx/scene/control/skin/VirtualContainerBase.java line 67:
> 65:
> 66: /**
> 67: * Constructs a {@code VirtualContainerBase}
The class is `abstract`, so possibly the constructor should be `protected`, and we might want to say "Constructor for subclasses" anyway.
-------------
PR: https://git.openjdk.java.net/jfx/pull/646
More information about the openjfx-dev
mailing list