United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4748245 : Doclet API: Doc.isClass() and all "class" references need clarification

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 RootDoc.classes() and PackageDoc.allClasses() mean
by "class" -- an interface, error, exception, or ordinary
class.

Doc.isClass() returns true if the item is a
"class", but not an interface. (It's not clear whether it
includes errors and exceptions, or not.)

Throughout the API, the word "class" needs to be clearly described
as to whether it means "class and interface" or "class, not interface".
======================================================================

                                    

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

Clarified isClass() by adding:

 * This includes errors and exceptions but not interfaces.

Added terminology section to package.html and clarified all 
program elements that contain the word "class".

No regression test included because this affects only the doc comment.

###@###.### 2002-09-29

                                     
2002-09-29
EVALUATION

If we want clarity I suggest renaming:
  RootDoc.classes() to RootDoc.classesAndInterfaces()
  PackageDoc.allClasses() to allClassesAndInterfaces()

###@###.### 2002-09-29
                                     
2002-09-29



Hardware and Software, Engineered to Work Together