RFR: 8271090: Missing API docs in scenegraph classes [v2]

Kevin Rushforth kcr at openjdk.java.net
Mon Oct 25 23:30:16 UTC 2021


On Mon, 25 Oct 2021 08:30:36 GMT, Ajit Ghaisas <aghaisas at openjdk.org> wrote:

>> This PR fixes javadoc warnings primarily in javafx.graphics module along with a remaining few in javafx.fxml, javafx.base and javafx.media modules.
>> 
>> Note :
>> - The javadoc needs to be generated with the JDK 18 EA build.
>> - There are still few remaining warnings in these modules. 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:
> 
>   8271090 - fix review comments

Looks good with a couple suggestions on `setScene`. We might want to also file a follow-up javadoc bug so we can get rid of the javadocs for that method altogether.

modules/javafx.graphics/src/main/java/javafx/stage/Window.java line 781:

> 779:      * Sets the value of the {@code scene} property.
> 780:      *
> 781:      * The {@code Scene} to be rendered on this {@code Window}. There can only

Can you add a `<p>` tag here? This will be closer to what an implicitly-generated setter would do.

modules/javafx.graphics/src/main/java/javafx/stage/Window.java line 798:

> 796:      * @defaultValue null
> 797:      *
> 798:      * @param value the value for the {@code scene} property

Can you add the following tags?
`@see getScene()`
`@see sceneProperty()`

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

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


More information about the openjfx-dev mailing list