RFR: 8252547: Correct transformations docs in Node

Kevin Rushforth kcr at openjdk.java.net
Fri Sep 11 21:49:44 UTC 2020

On Mon, 31 Aug 2020 23:28:51 GMT, Nir Lisker <nlisker at openjdk.org> wrote:

> Correction to the order of transforms specified in the docs of `Node`.

The updated text look good, although there is a javadoc error that causes the build to fail. I left a few comments

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

> 333:  * </ol>
> 334:  * The transforms are applied in the reverse order of the matrix multiplication outlined above: last element of
> the transforms list 335:  * to 0th element, scale, rotate, and layout and translate. By applying the transforms in this
> order, the bound in the local

"bounds" should be plural.

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

> 326:  * The matrices that represent the transforms are multiplied in this order:
> 327:  * <ol>
> 328:  * <li> Layout ({@link #layoutXProperty layoutX}), {@link #layoutYProperty layoutY} and translate

The closing paren should be after `layoutY`:

    * <li> Layout ({@link #layoutXProperty layoutX}, {@link #layoutYProperty layoutY}) and ...

Also, can you add `</li>` after each item?

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

> 3421:      *
> 3422:      * @return the {@code boundsInParent} property for this {@code Node}
> 3423:      * @see {@linkplain Node Bounding Rectangles} section in the class docs

This causes a javadoc error:

> Task :javadoc
modules\javafx.graphics\src\main\java\javafx\scene\Node.java:3423: error: unexpected content
     * @see {@linkplain Node Bounding Rectangles} section in the class docs
1 error

> Task :javadoc FAILED


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

More information about the openjfx-dev mailing list