-
Notifications
You must be signed in to change notification settings - Fork 541
8252547: Correct transformations docs in Node #293
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
8252547: Correct transformations docs in Node #293
Conversation
|
👋 Welcome back nlisker! A progress list of the required criteria for merging this PR into |
Webrevs
|
|
/reviewers 2 |
|
@kevinrushforth |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The updated text look good, although there is a javadoc error that causes the build to fail. I left a few comments below.
| * @return the boundsInParent for this {@code Node} | ||
| * | ||
| * @return the {@code boundsInParent} property for this {@code Node} | ||
| * @see {@linkplain Node Bounding Rectangles} section in the class docs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@see doesn't show for properties because of the special handling (same goes for @return). I opted to create HTML links to the headers instead. I did it to all for them even if they are not all used.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes look good to me. I asked one question about whether you wanted to add another hyperlink, but it's up to you.
| * </ol> | ||
| * The transforms are applied in the reverse order of the matrix multiplication outlined above: last element of the transforms list | ||
| * to 0th element, scale, rotate, and layout and translate. By applying the transforms in this order, the bounds in the local | ||
| * coordinates of the node are transformed to the bounds in the parent coordinate of the node (see the <b>Bounding Rectangles</b> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe hyperlink to the Bounding Rectangles section? (although as it is right below, it isn't as important).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Originally I had "see the next section" but didn't want to depend on the order. I put the link anyway.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
change looks good to me, javadoc built with no problem.
|
@nlisker This change now passes all automated pre-integration checks. In addition to the automated checks, the change must also fulfill all project specific requirements After integration, the commit message will be:
Since the source branch of this PR was last updated there have been 6 commits pushed to the
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid automatic rebasing, please merge ➡️ To integrate this PR with the above commit message to the |
|
/integrate |
|
@nlisker Since your change was applied there have been 6 commits pushed to the
Your commit was automatically rebased without conflicts. Pushed as commit d6dee34. 💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored. |
Correction to the order of transforms specified in the docs of
Node.Progress
Issue
Reviewers
Download
$ git fetch https://git.openjdk.java.net/jfx pull/293/head:pull/293$ git checkout pull/293