RFR: 8325550: Grammatical error in AnchorPane.setLeftAnchor (and other setters) javadoc
Kevin Rushforth
kcr at openjdk.org
Fri Feb 23 19:44:00 UTC 2024
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.
The changes to the docs look fine, although I note the same additional warnings that Andy saw (restoring the `@return` will fix it; the text after the `@return` doesn't matter, since it is unused).
Also, I think it would be better to revert all code changes, even though they look harmless.
modules/javafx.graphics/src/main/java/javafx/scene/Node.java line 6449:
> 6447: EFFECTIVE_ORIENTATION_LTR | AUTOMATIC_ORIENTATION_LTR;
> 6448:
> 6449: private static final NodeOrientation DEFAULT_NODE_ORIENTATION = NodeOrientation.INHERIT;
This is unrelated to the doc change (and the addition of a static final const makes it not strictly a doc-only change). Presuming that you want to backport this to jfx22, I recommend to revert this change. Especially since the RC deadline is next week.
modules/javafx.graphics/src/main/java/javafx/scene/Node.java line 6465:
> 6463: * of text in both worlds.
> 6464: *
> 6465: * @defaultValue {@code NodeOrientation.INHERIT}
The `@return` is still needed (although unused) to avoid a warning.
modules/javafx.graphics/src/main/java/javafx/scene/Scene.java line 6245:
> 6243:
> 6244: @SuppressWarnings("removal")
> 6245: private static final NodeOrientation DEFAULT_NODE_ORIENTATION =
Same comment as in Node.java -- I recommend reverting this change if you intend to backport it to jfx22.
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.
-------------
PR Review: https://git.openjdk.org/jfx/pull/1379#pullrequestreview-1898671234
PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501010198
PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501010794
PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501011782
PR Review Comment: https://git.openjdk.org/jfx/pull/1379#discussion_r1501093086
More information about the openjfx-dev
mailing list