RFR: 8271090: Missing API docs in scenegraph classes

Kevin Rushforth kcr at openjdk.java.net
Fri Oct 22 15:30:10 UTC 2021


On Fri, 22 Oct 2021 14:48:31 GMT, Nir Lisker <nlisker 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)
>
> modules/javafx.graphics/src/main/java/javafx/scene/Camera.java line 164:
> 
>> 162:     /**
>> 163:      * Creates a {@code Camera}.
>> 164:      */
> 
> Sine the constructor is a `protected` for an `abstract` class, it doesn't create a `Camera` in the normal sense of constructors. I would write something like "Shared constructor for subclasses of `Camera`".

Good catch. We've started using "Constructor for subclasses to call." as the description of such classes. See PR #283 for example.

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

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


More information about the openjfx-dev mailing list