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

8240451: JavaFX javadoc build fails with JDK 14 #133

Closed

Conversation

kevinrushforth
Copy link
Member

@kevinrushforth kevinrushforth commented Mar 3, 2020

The JDK 14 javadoc will emit a warning for an @pram tag of a generic parameter if not surrounded by < and >. This will in turn fail the build, since we treat warnings as errors. There are 5 classes in JavaFX with this error. The fix is to replace @param T with @param <T> in those 5 places.

I have tested this fix using javadoc from both JDK 13 and JDK 14.


Progress

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

Issue

Reviewers

  • Nir Lisker (nlisker - Committer)
  • Johan Vos (jvos - Reviewer)

Download

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

@kevinrushforth kevinrushforth self-assigned this Mar 3, 2020
@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Mar 3, 2020

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

@openjdk openjdk bot added the rfr label Mar 3, 2020
@mlbridge
Copy link

@mlbridge mlbridge bot commented Mar 3, 2020

Webrevs

nlisker
nlisker approved these changes Mar 5, 2020
Copy link
Collaborator

@nlisker nlisker left a comment

Using a rough regex search of @param [A-Z]\s I also found:

com.sun.glass.ui.Window#requestInput: @param M
com.sun.javafx.tk.TKStage#requestInput: @param M

Though those are internal.

@kevinrushforth
Copy link
Member Author

@kevinrushforth kevinrushforth commented Mar 5, 2020

Thanks for the review. Yeah, I only looked at the public API classes.

Can I get a "R"eviewer to look at this? Maybe @arapte or @aghaisas ?

@openjdk
Copy link

@openjdk openjdk bot commented Mar 5, 2020

@kevinrushforth 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:

8240451: JavaFX javadoc build fails with JDK 14

Reviewed-by: nlisker, jvos
  • 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.

Since the source branch of this PR was last updated there have been 2 commits pushed to the master branch. Since 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 master into your branch, and then specify the current head hash when integrating, like this: /integrate cf0bba62deed21d3fd47a3c54cf1d23ad5968af9.

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

@openjdk openjdk bot added the ready label Mar 5, 2020
@kevinrushforth
Copy link
Member Author

@kevinrushforth kevinrushforth commented Mar 5, 2020

/integrate

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

@openjdk openjdk bot commented Mar 5, 2020

@kevinrushforth The following commits have been pushed to master since your change was applied:

  • cf0bba6: 8240211: Stack overflow on Windows 32-bit can lead to crash
  • 337ed72: 8237926: Potential memory leak of model data in javafx.scene.control.ListView

Your commit was automatically rebased without conflicts.

Pushed as commit b2ac76a.

@mlbridge
Copy link

@mlbridge mlbridge bot commented Mar 5, 2020

Mailing list message from Kevin Rushforth on openjfx-dev:

Changeset: b2ac76a
Author: Kevin Rushforth <kcr at openjdk.org>
Date: 2020-03-05 20:58:03 +0000
URL: https://git.openjdk.java.net/jfx/commit/b2ac76a9

8240451: JavaFX javadoc build fails with JDK 14

Reviewed-by: nlisker, jvos

! modules/javafx.base/src/main/java/javafx/beans/property/adapter/JavaBeanObjectProperty.java
! modules/javafx.base/src/main/java/javafx/beans/property/adapter/JavaBeanObjectPropertyBuilder.java
! modules/javafx.base/src/main/java/javafx/beans/property/adapter/ReadOnlyJavaBeanObjectProperty.java
! modules/javafx.base/src/main/java/javafx/beans/property/adapter/ReadOnlyJavaBeanObjectPropertyBuilder.java
! modules/javafx.base/src/main/java/javafx/beans/value/WritableObjectValue.java

@kevinrushforth kevinrushforth deleted the 8240451-javadoc-param branch Mar 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated
3 participants