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: 4748245
Votes 0
Synopsis Doclet API: Doc.isClass() and all "class" references need clarification
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
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.

 xxxxx@xxxxx  2002-09-29



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".
======================================================================
Work Around





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

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


PLEASE NOTE: JDK6 is formerly known as Project Mustang