United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4748240 : Doclet API: Clarify PackageDoc.allClasses() method and the term "included"

Details
Type:
Bug
Submit Date:
2002-09-16
Status:
Resolved
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2002-10-26
Component:
tools
OS:
generic
Sub-Component:
javadoc(tool)
CPU:
generic
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.4.0
Fixed Versions:
1.4.2 (mantis)

Related Reports

Sub Tasks

Description
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
senses. 

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.)

======================================================================

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
mantis

FIXED IN:
mantis

INTEGRATED IN:
mantis
mantis-b05


                                     
2004-06-14
WORK AROUND



Name: eaT66865			Date: 09/16/2002



======================================================================
                                     
2004-06-11
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
                                     
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
                                     
2002-09-25



Hardware and Software, Engineered to Work Together