JDK-4748245 : Doclet API: Doc.isClass() and all "class" references need clarification
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.4.0
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS: generic
  • CPU: generic
  • Submitted: 2002-09-16
  • Updated: 2014-05-05
  • Resolved: 2002-10-26
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availability Release.

To download the current JDK release, click here.
1.4.2 mantisFixed
Name: eaT66865			Date: 09/16/2002

The RootDoc.classes() and PackageDoc.allClasses() mean
by "class" -- an interface, error, exception, or ordinary

Doc.isClass() returns true if the item is a
"class", but not an interface. (It's not clear whether it
includes errors and exceptions, or not.)

Throughout the API, the word "class" needs to be clearly described
as to whether it means "class and interface" or "class, not interface".

CONVERTED DATA BugTraq+ Release Management Values COMMIT TO FIX: mantis FIXED IN: mantis INTEGRATED IN: mantis mantis-b05

WORK AROUND Name: eaT66865 Date: 09/16/2002 ======================================================================

PUBLIC COMMENTS Clarified isClass() by adding: * This includes errors and exceptions but not interfaces. Added terminology section to package.html and clarified all program elements that contain the word "class". No regression test included because this affects only the doc comment. ###@###.### 2002-09-29

EVALUATION If we want clarity I suggest renaming: RootDoc.classes() to RootDoc.classesAndInterfaces() PackageDoc.allClasses() to allClassesAndInterfaces() ###@###.### 2002-09-29