Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8249633

doclint reports missing javadoc for JavaFX property methods that have a property description

    Details

    • Type: Bug
    • Status: Resolved
    • Priority: P3
    • Resolution: Fixed
    • Affects Version/s: 15
    • Fix Version/s: 16
    • Component/s: tools
    • Labels:

      Backports

        Description

        For JavaFX properties -- which are defined as attributes that have a xxxxProperty method that returns a subclass of javafx.beans.Observable, a getXxxx method, and an optional setXxxx method -- the description on the property itself is copied to the three public methods by the standard doclet.

        When running javadoc with `-Xdoclint:missing" the methods without a javadoc comment body are flagged as missing a comment even when the property itseld does have a comment that will be copied.

        This produces a few thousand warnings when build the JavaFX docs with JDK 15.

        To reproduce it, either clone the jfx repo and run "gradle javadoc" or else download the JavaFX 15 SDK and run the attached test program as follows:

        javadoc -d build --source-path src \
                --module-path /SOMEWHERE/javafx-sdk-15/lib \
                --add-modules javafx.base \
                -Xdoclint:all \
                pkg

          Attachments

            Issue Links

              Activity

                People

                • Assignee:
                  jjg Jonathan Gibbons
                  Reporter:
                  kcr Kevin Rushforth
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  3 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved: