RFR: 8325550: Grammatical error in AnchorPane.setLeftAnchor (and other setters) javadoc

Nir Lisker nlisker at openjdk.org
Fri Feb 23 20:19:57 UTC 2024


On Fri, 23 Feb 2024 19:44:06 GMT, Andy Goryachev <angorya at openjdk.org> wrote:

>> modules/javafx.graphics/src/main/java/javafx/scene/Scene.java line 6272:
>> 
>>> 6270:      * of text in both worlds.
>>> 6271:      *
>>> 6272:      * @defaultValue if the system property {@code javafx.scene.nodeOrientation.RTL} is {@code true},
>> 
>> Restore the `@return` to avoid a warning.
>
> it seems that placing javadoc at the property declaration instead of the method which returns said property eliminates the warning. 
> See for example Stage:1329

Yes, this is why I was surprised that new warnings showed up. The `@return` text is auto-generated for properties, so why would a return tag be needed? I guess the doc tool doesn't understand that when the doc is placed on the property getter instead of on the field, which I think is a bug.

I suggest to move the doc to the field.

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

PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501126942


More information about the openjfx-dev mailing list