Java Solaris Communities Sun Store Join SDN My Profile Why Join?
 
Bug Database
Bug Detail
Quick Lists
Top 25 Bugs
Top 25 RFE's
Recently Closed Bugs
Printable Page Printable Page


Bug Database
Bug ID: 4748240
Votes 0
Synopsis Doclet API: Clarify PackageDoc.allClasses() method and the term "included"
Category doclet:tbd
Reported Against 1.4
Release Fixed 1.4.2(mantis)
State 10-Fix Delivered, bug
Priority: 4-Low
Related Bugs
Submit Date 16-SEP-2002
Description
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.

 xxxxx@xxxxx  2002-10-05

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

======================================================================
Work Around





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

 xxxxx@xxxxx  2002-09-25
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang