RFR: 8271090: Missing API docs in scenegraph classes [v3]
Ajit Ghaisas
aghaisas at openjdk.java.net
Thu Oct 28 07:23:58 UTC 2021
On Wed, 27 Oct 2021 16:06:38 GMT, Nir Lisker <nlisker at openjdk.org> wrote:
> Added a few more comments, otherwise looks fine.
Thanks for your detailed review.
> modules/javafx.graphics/src/main/java/javafx/stage/PopupWindow.java line 156:
>
>> 154:
>> 155: /**
>> 156: * Creates a {@code PopupWindow}.
>
> The `PopupWIndow` class is abstract. Do we still keep this wording?
I have changed it to - "Constructor for subclasses to call." as in other cases.
> modules/javafx.graphics/src/main/java/javafx/stage/Window.java line 794:
>
>> 792: *
>> 793: * An {@link IllegalStateException} is thrown if this property is set
>> 794: * on a thread other than the JavaFX Application Thread.</p>
>
> Shouldn't this be in a `@throws`?
Yes, only javadoc for `setScene()` method should use `@throws`.
The description for the property does not (and should not) recognize a `@throws`, hence I have kept the original description intact.
-------------
PR: https://git.openjdk.java.net/jfx/pull/650
More information about the openjfx-dev
mailing list