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

[Ajit Ghaisas]

On Fri, 22 Oct 2021 15:00:58 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

>> Ajit Ghaisas has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   8271090 - fix review comments
>
> modules/javafx.graphics/src/main/java/javafx/stage/Window.java line 781:
> 
>> 779:      * Sets the {@code Scene} of this {@code Window}.
>> 780:      * @param value the {@code Scene} to be set
>> 781:      */
> 
> The javadoc tool automatically generates docs for this setter (you can see this from the generated docs without this change), including the property description, so this change will actually lose information. I'm guessing that the tool warns on this method because the setter is protected (rather than public). So we should probably file a bug against the javadoc tool. As for how to fix it, you can either suppress the warning (I'm not sure whether that's possible), or you can copy the information from the property method with a leading sentence that matches what javadoc _would_ generate.

Suppressing this warning is logical - but not possible.
As suggested, I have copied the property information and added the set method description that was generated by javadoc tool before this fix.

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

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