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: 4748238
Votes 0
Synopsis Doclet API: RootDoc.classes() and PackageDoc.allClasses() inconsistent comments
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
The distinction between classes() and allClasses() has been made clearer
in the doc comments.
No regression test is required as this is a change only to the doc comments.
 xxxxx@xxxxx  2002-10-10


The RootDoc.classes() and PackageDoc.allClasses()
appear to do the same thing, but have different names.
If different, the api comments should make it clear.

Note:
allClasses() indicates that it includes errors
and exceptions, but classes() doesn't. But classes()
must do so, so that should be clarified, as well.

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





======================================================================
Evaluation
Changed synopsis from:
  JavaDoc API inconsistency

  RootDoc.classes() and PackageDoc.allClasses() inconsistent comments

The methods do similar things:
RootDoc.classes() gets all doc'd classes & interfaces in all packages, while
PackageDoc.allClasses() gets all doc'd classes & interfaces in given package.

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


PLEASE NOTE: JDK6 is formerly known as Project Mustang