← Back to team overview

openjdk team mailing list archive

  1. openjdk team
  2. Mailing list archive
  3. Message #12493

[Bug 1706969] [NEW] JavaDoc reports warning for methods named is*Property*

  Thread Previous • Date Previous • • Thread Next 
Public bug reported:

When generating javadoc, warnings are reported if there are methods
named like is*Property* (ie. public boolean isProperty).

This fails with:
openjdk version "1.8.0_131" 
OpenJDK Runtime Environment (build 1.8.0_131-8u131-b11-0ubuntu1.16.04.2-b11) 
OpenJDK 64-Bit Server VM (build 25.131-b11, mixed mode) 

But it works with OracleJDK 8:
java version "1.8.0_131"
Java(TM) SE Runtime Environment (build 1.8.0_131-b11)
Java HotSpot(TM) 64-Bit Server VM (build 25.131-b11, mixed mode)

and it also works with OpenJDK 7:
java version "1.7.0_95" 
OpenJDK Runtime Environment (IcedTea 2.6.4) (7u95-2.6.4-3) 
OpenJDK 64-Bit Server VM (build 24.95-b01, mixed mode) 

Steps to reproduce:
Having the following class: 

public class TestJavaDoc { 
  public boolean isProperty() { 
    return false; 
  } 
} 

run: javadoc TestJavaDoc.java -verbose 
Loading source file TestJavaDoc.java... 
[parsing started RegularFileObject[TestJavaDoc.java]] 
[parsing completed 11ms] 
Constructing Javadoc information... 
[search path for source files: .] 
[search path for class files: /usr/lib/jvm/java-8-openjdk-amd64/jre/lib/resources.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/rt.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/sunrsasign.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jsse.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jce.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/charsets.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jfr.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/classes,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/nashorn.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/sunec.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/icedtea-sound.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/localedata.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/dnsns.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/sunpkcs11.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/jaccess.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/cldrdata.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/zipfs.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/sunjce_provider.jar,.] 
[loading ZipFileIndexFileObject[/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/rt.jar(java/lang/Object.class)]] 
Standard Doclet version 1.8.0_131 
Building tree for all the packages and classes... 
Generating ./TestJavaDoc.html... 
TestJavaDoc.java:3: warning - @propertyDescription is an unknown tag. 
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
TestJavaDoc.java:3: warning - @propertyDescription is an unknown tag. 
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
[loading ZipFileIndexFileObject[/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/rt.jar(java/io/Serializable.class)]] 
Generating ./package-frame.html... 
Generating ./package-summary.html... 
Generating ./package-tree.html... 
Generating ./constant-values.html... 
Building index for all the packages and classes... 
Generating ./overview-tree.html... 
Generating ./index-all.html... 
Generating ./deprecated-list.html... 
Building index for all classes... 
Generating ./allclasses-frame.html... 
Generating ./allclasses-noframe.html... 
Generating ./index.html... 
Generating ./help-doc.html... 
[done in 449 ms] 
8 warnings 

Note: I reported this issue to openjdk but they rejected considering it a bug in Ubuntu's build:
https://bugs.openjdk.java.net/browse/JDK-8185424

ProblemType: Bug
DistroRelease: Ubuntu 16.04
Package: openjdk-8-jdk-headless 8u131-b11-0ubuntu1.16.04.2
ProcVersionSignature: Ubuntu 4.4.0-79.100-generic 4.4.67
Uname: Linux 4.4.0-79-generic x86_64
ApportVersion: 2.20.1-0ubuntu2.6
Architecture: amd64
CurrentDesktop: Unity
Date: Thu Jul 27 14:53:50 2017
InstallationDate: Installed on 2015-08-03 (724 days ago)
InstallationMedia: Ubuntu 15.04 "Vivid Vervet" - Release amd64 (20150422)
SourcePackage: openjdk-8
UpgradeStatus: Upgraded to xenial on 2016-09-23 (306 days ago)

** Affects: openjdk-8 (Ubuntu)
     Importance: Undecided
         Status: New


** Tags: amd64 apport-bug third-party-packages xenial

-- 
You received this bug notification because you are a member of OpenJDK,
which is subscribed to openjdk-8 in Ubuntu.
https://bugs.launchpad.net/bugs/1706969

Title:
  JavaDoc reports warning for methods named is*Property*

Status in openjdk-8 package in Ubuntu:
  New

Bug description:
  When generating javadoc, warnings are reported if there are methods
  named like is*Property* (ie. public boolean isProperty).

  This fails with:
  openjdk version "1.8.0_131" 
  OpenJDK Runtime Environment (build 1.8.0_131-8u131-b11-0ubuntu1.16.04.2-b11) 
  OpenJDK 64-Bit Server VM (build 25.131-b11, mixed mode) 

  But it works with OracleJDK 8:
  java version "1.8.0_131"
  Java(TM) SE Runtime Environment (build 1.8.0_131-b11)
  Java HotSpot(TM) 64-Bit Server VM (build 25.131-b11, mixed mode)

  and it also works with OpenJDK 7:
  java version "1.7.0_95" 
  OpenJDK Runtime Environment (IcedTea 2.6.4) (7u95-2.6.4-3) 
  OpenJDK 64-Bit Server VM (build 24.95-b01, mixed mode) 

  Steps to reproduce:
  Having the following class: 

  public class TestJavaDoc { 
    public boolean isProperty() { 
      return false; 
    } 
  } 

  run: javadoc TestJavaDoc.java -verbose 
  Loading source file TestJavaDoc.java... 
  [parsing started RegularFileObject[TestJavaDoc.java]] 
  [parsing completed 11ms] 
  Constructing Javadoc information... 
  [search path for source files: .] 
  [search path for class files: /usr/lib/jvm/java-8-openjdk-amd64/jre/lib/resources.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/rt.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/sunrsasign.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jsse.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jce.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/charsets.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/jfr.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/classes,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/nashorn.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/sunec.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/icedtea-sound.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/localedata.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/dnsns.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/sunpkcs11.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/jaccess.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/cldrdata.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/zipfs.jar,/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/ext/sunjce_provider.jar,.] 
  [loading ZipFileIndexFileObject[/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/rt.jar(java/lang/Object.class)]] 
  Standard Doclet version 1.8.0_131 
  Building tree for all the packages and classes... 
  Generating ./TestJavaDoc.html... 
  TestJavaDoc.java:3: warning - @propertyDescription is an unknown tag. 
  TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
  TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
  TestJavaDoc.java:3: warning - @propertyDescription is an unknown tag. 
  TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
  TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
  TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
  TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescription can only be used in JavaFX properties getters and setters. 
  [loading ZipFileIndexFileObject[/usr/lib/jvm/java-8-openjdk-amd64/jre/lib/rt.jar(java/io/Serializable.class)]] 
  Generating ./package-frame.html... 
  Generating ./package-summary.html... 
  Generating ./package-tree.html... 
  Generating ./constant-values.html... 
  Building index for all the packages and classes... 
  Generating ./overview-tree.html... 
  Generating ./index-all.html... 
  Generating ./deprecated-list.html... 
  Building index for all classes... 
  Generating ./allclasses-frame.html... 
  Generating ./allclasses-noframe.html... 
  Generating ./index.html... 
  Generating ./help-doc.html... 
  [done in 449 ms] 
  8 warnings 

  Note: I reported this issue to openjdk but they rejected considering it a bug in Ubuntu's build:
  https://bugs.openjdk.java.net/browse/JDK-8185424

  ProblemType: Bug
  DistroRelease: Ubuntu 16.04
  Package: openjdk-8-jdk-headless 8u131-b11-0ubuntu1.16.04.2
  ProcVersionSignature: Ubuntu 4.4.0-79.100-generic 4.4.67
  Uname: Linux 4.4.0-79-generic x86_64
  ApportVersion: 2.20.1-0ubuntu2.6
  Architecture: amd64
  CurrentDesktop: Unity
  Date: Thu Jul 27 14:53:50 2017
  InstallationDate: Installed on 2015-08-03 (724 days ago)
  InstallationMedia: Ubuntu 15.04 "Vivid Vervet" - Release amd64 (20150422)
  SourcePackage: openjdk-8
  UpgradeStatus: Upgraded to xenial on 2016-09-23 (306 days ago)

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/openjdk-8/+bug/1706969/+subscriptions

Follow ups

  Thread Previous • Date Previous • • Thread Next