United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
Bug ID: JDK-4748238 Doclet API: RootDoc.classes() and PackageDoc.allClasses() inconsistent comments
JDK-4748238 : Doclet API: RootDoc.classes() and PackageDoc.allClasses() inconsistent comments

Details
Type:
Bug
Submit Date:
2002-09-16
Status:
Resolved
Updated Date:
2002-10-26
Project Name:
JDK
Resolved Date:
2002-10-26
Component:
docs
OS:
generic
Sub-Component:
doclet
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 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.

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

                                    

Comments
EVALUATION

Changed synopsis from:
  JavaDoc API inconsistency
to:
  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.

###@###.### 2002-09-25
                                     
2002-09-25
PUBLIC COMMENTS

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.
###@###.### 2002-10-10
                                     
2002-10-10
WORK AROUND



Name: eaT66865			Date: 09/16/2002



======================================================================
                                     
2004-06-11
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
mantis

FIXED IN:
mantis

INTEGRATED IN:
mantis
mantis-b05


                                     
2004-06-14



Hardware and Software, Engineered to Work Together