JDK-4748240 : Doclet API: Clarify PackageDoc.allClasses() method and the term "included"
  • 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 allClasses method says 
"Get all included classes (including Exceptions 
         ^^^^^^^^          ^^^^^^^^^^
and Errors) and interfaces."

That phrasing uses the word "include" in two different

More importantly, the sense of what "included classes" 
means should be clarified, since it's not obvious. 
(It's the classes which are included in the documentation
set by virtue of the command line switches with which
JavaDoc was invoked.)


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 Added a terminology section to package.html and added references to it. Clarified everywhere "class" appears whether it means "class and interface" or "class as opposed to interface". No regression test needed because this fix changes only doc comments. ###@###.### 2002-10-05

EVALUATION The term "included" in "included classes" means those program elements that are present in the documentation generated by javadoc. Note this is normally a subset of the classes passed in on the command line, due to filtering out of some classes by the access modifiers (-public, -protected, -package and -private). ###@###.### 2002-09-25