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

javadoc generates incorrect missing comment warning in one case for JavaFX property

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Unresolved
    • Icon: P4 P4
    • 24
    • 21, 22, 23
    • tools
    • None

      I haven't been able to narrow this down to a simple test program.

      To reproduce this, build the JavaFX docs from the jfx22 branch of the GitHub jfx repo using JDK 21 (or later) as follows:

      git clone https://github.com/openjdk/jfx.git
      cd jfx
      git checkout jfx22
      bash gradlew javadoc

      It will produce 186 warnings, 2 of which are incorrect.

      jfx/modules/javafx.controls/src/main/java/javafx/scene/control/Skinnable.java:55: warning: no comment
          public void setSkin(Skin<?> value);
                      ^
      jfx/modules/javafx.controls/src/main/java/javafx/scene/control/Skinnable.java:57: warning: no comment
          public Skin<?> getSkin();
                         ^

      There is a corresponding skinProperty() method in the same interface, and the javadoc tool correctly produces the docs for these two methods from the property.

      WORKAROUND: Annotate the two methods with `@SuppressWarnings("doclint:missing")`

            hannesw Hannes Wallnoefer
            kcr Kevin Rushforth
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: