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

[Andy Goryachev]

On Fri, 23 Feb 2024 17:46:20 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

> Fixes for the `AnchorPane` docs, as well as for the `NodeOrientation` docs in `Node` and `Scene`.
> 
> Note that the default value for a `Scene`'s `NodeOrientation` depends on a system property, while for `Node` it isn't (which means `SubScene` will be different from `Scene`). Not sure if this is intended.

looks good (with minor suggestion)
however, this change adds 2 javadoc warnings which need to be addressed,  I would think .

modules/javafx.graphics/src/main/java/javafx/scene/Node.java line 6465:

> 6463:      * of text in both worlds.
> 6464:      *
> 6465:      * @defaultValue {@code NodeOrientation.INHERIT}

adds a javadoc warning:


/Users/angorya/Projects/jfx3/jfx/rt/modules/javafx.graphics/src/main/java/javafx/scene/Node.java:6468: warning: no @return
    public final ObjectProperty<NodeOrientation> nodeOrientationProperty() {
                                                 ^

modules/javafx.graphics/src/main/java/javafx/scene/Scene.java line 6273:

> 6271:      *
> 6272:      * @defaultValue if the system property {@code javafx.scene.nodeOrientation.RTL} is {@code true},
> 6273:      *     {@code NodeOrientation.RIGHT_TO_LEFT}, otherwise {@code NodeOrientation.INHERIT}

adds a javadoc warning:


/Users/angorya/Projects/jfx3/jfx/rt/modules/javafx.graphics/src/main/java/javafx/scene/Scene.java:6276: warning: no @return
    public final ObjectProperty<NodeOrientation> nodeOrientationProperty() {
                                                 ^

modules/javafx.graphics/src/main/java/javafx/scene/layout/AnchorPane.java line 187:

> 185:      * Returns the child's bottom anchor constraint, if set.
> 186:      * @param child the child node of an anchor pane
> 187:      * @return the offset from the bottom of the anchor pane, or {@code null} if no bottom anchor was set

minor suggestion: move explanation of when it returns null to the description,  i.e.:


Returns the child's bottom anchor constraint, if set, otherwise returns {@code null}.

@return the offset from the bottom of the anchor pane, or {@code null}

modules/javafx.graphics/src/main/java/javafx/scene/layout/AnchorPane.java line 209:

> 207:      * Returns the child's right anchor constraint, if set.
> 208:      * @param child the child node of an anchor pane
> 209:      * @return the offset from the right of the anchor pane, or {@code null} if no right anchor was set

and here

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

Changes requested by angorya (Reviewer).

PR Review: https://git.openjdk.org/jfx/pull/1379#pullrequestreview-1898708803
PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501034793
PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501035303
PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501033228
PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501033642