Skip to content
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

8228867: Fix mistakes in FX API docs #110

Closed

Conversation

@nlisker
Copy link
Collaborator

nlisker commented Feb 11, 2020

Docs fixes for OpenJFX 14. We can wait with integrating this in case there are last minute fixes, but reviews can start.


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

Reviewers

  • Johan Vos (jvos - Reviewer)
  • Kevin Rushforth (kcr - Reviewer)

Download

$ git fetch https://git.openjdk.java.net/jfx pull/110/head:pull/110
$ git checkout pull/110

@bridgekeeper
Copy link

bridgekeeper bot commented Feb 11, 2020

👋 Welcome back nlisker! A progress list of the required criteria for merging this PR into jfx14 will be added to the body of your pull request.

@openjdk openjdk bot added the rfr label Feb 11, 2020
@mlbridge
Copy link

mlbridge bot commented Feb 11, 2020

Webrevs

@kevinrushforth
Copy link
Member

kevinrushforth commented Feb 11, 2020

The changes so far look fine. As you say, we can wait for a bit to finish the review of this.

One request: Given that this might be the last fix for jfx14, can you update the copyright year to 2020 in the modified files? It will save me having to do one last "Update copyright year to 2020" fix right before GAC of JavaFX 14.

@nlisker
Copy link
Collaborator Author

nlisker commented Feb 11, 2020

can you update the copyright year to 2020 in the modified files?

Yeah, I'll do it in the last commit.

Copy link
Collaborator

johanvos left a comment

Those are small but useful fixes.
I'm already approving it; in case there is a new commit before the GA number is tagged, the Skara bot should request a new review (hence this is a good testcase).

@openjdk
Copy link

openjdk bot commented Feb 12, 2020

@nlisker This change now passes all automated pre-integration checks. When the change also fulfills all project specific requirements, type /integrate in a new comment to proceed. After integration, the commit message will be:

8228867: Fix mistakes in FX API docs

Reviewed-by: jvos, kcr
  • If you would like to add a summary, use the /summary command.
  • To credit additional contributors, use the /contributor command.
  • To add additional solved issues, use the /solves command.

➡️ To integrate this PR with the above commit message, type /integrate in a new comment.

@openjdk openjdk bot added the ready label Feb 12, 2020
@openjdk openjdk bot removed the ready label Feb 18, 2020
@mlbridge
Copy link

mlbridge bot commented Feb 18, 2020

Mailing list message from Tom Schindl on openjfx-dev:

IIRC I had filed a bugzilla a while ago at Eclipse on a javadoc Problem like that

Tom

Von meinem iPhone gesendet

Am 18.02.2020 um 20:09 schrieb Nir Lisker <nlisker at openjdk.java.net>:

?On Tue, 18 Feb 2020 18:15:30 GMT, Kevin Rushforth <kcr at openjdk.org> wrote:

The pull request has been updated with 2 additional commits.

modules/javafx.base/src/main/java/javafx/collections/ListChangeListener.java line 234:

233: *
234: * <pre><code> for (Node n : change.getAddedSubList()) {
235: * // do something

What is the problem with the existing example? It already matches our preferred pattern for example code:

* <pre>{@code
* sample code
* goes here
* }</pre>

Oh, in Eclipse that was not rendered correctly, probably because of the interaction between `<pre>` and `{@code}`. Do you want me to revert?

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

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

nlisker added 2 commits Feb 18, 2020
Copy link
Member

kevinrushforth left a comment

Looks good.

@openjdk openjdk bot added the ready label Feb 18, 2020
@nlisker
Copy link
Collaborator Author

nlisker commented Feb 19, 2020

/integrate

@openjdk openjdk bot closed this Feb 19, 2020
@openjdk openjdk bot added integrated and removed ready rfr labels Feb 19, 2020
@openjdk
Copy link

openjdk bot commented Feb 19, 2020

@nlisker
Pushed as commit 35a01ca.

@nlisker nlisker deleted the nlisker:8228867_Fix_mistakes_in_FX_API_docs branch Feb 19, 2020
@nlisker nlisker restored the nlisker:8228867_Fix_mistakes_in_FX_API_docs branch Feb 19, 2020
@nlisker nlisker deleted the nlisker:8228867_Fix_mistakes_in_FX_API_docs branch Feb 19, 2020
@mlbridge
Copy link

mlbridge bot commented Feb 19, 2020

Mailing list message from Nir Lisker on openjfx-dev:

Changeset: 35a01ca
Author: Nir Lisker <nlisker at openjdk.org>
Date: 2020-02-19 14:35:56 +0000
URL: https://git.openjdk.java.net/jfx/commit/35a01caf

8228867: Fix mistakes in FX API docs

Reviewed-by: jvos, kcr

! modules/javafx.base/src/main/java/javafx/collections/FXCollections.java
! modules/javafx.graphics/src/main/java/javafx/animation/Animation.java
! modules/javafx.graphics/src/main/java/javafx/application/Platform.java
! modules/javafx.graphics/src/main/java/javafx/scene/Node.java
! modules/javafx.graphics/src/main/native-glass/win/OleUtils.h

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.