JavaDoc reports warning for methods named is*Property*
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
openjdk-8 (Ubuntu) |
Confirmed
|
Undecided
|
Unassigned |
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-
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 RegularFileObje
[parsing completed 11ms]
Constructing Javadoc information...
[search path for source files: .]
[search path for class files: /usr/lib/
[loading ZipFileIndexFil
Standard Doclet version 1.8.0_131
Building tree for all the packages and classes...
Generating ./TestJavaDoc.
TestJavaDoc.java:3: warning - @propertyDescri
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescri
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescri
TestJavaDoc.java:3: warning - @propertyDescri
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescri
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescri
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescri
TestJavaDoc.java:3: warning - Tags @propertyGetter, @propertySetter and @propertyDescri
[loading ZipFileIndexFil
Generating ./package-
Generating ./package-
Generating ./package-
Generating ./constant-
Building index for all the packages and classes...
Generating ./overview-
Generating ./index-all.html...
Generating ./deprecated-
Building index for all classes...
Generating ./allclasses-
Generating ./allclasses-
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:/
ProblemType: Bug
DistroRelease: Ubuntu 16.04
Package: openjdk-
ProcVersionSign
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)
Status changed to 'Confirmed' because the bug affects multiple users.