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: 4307151
Votes 0
Synopsis stddoclet: should use "nested classes" rather than "inner classes"
Category doclet:tbd
Reported Against 1.2
Release Fixed 1.4(merlin-beta)
State 10-Fix Delivered, bug
Priority: 4-Low
Related Bugs
Submit Date 25-JAN-2000
Description
Replaced strings "Inner", "inner" and "INNER" with "Nested", "nested" and "NESTED" respectively in the following files:

standard.properties
ClassSubWriter.java
ClassWriter.java
HtmlStandardWriter.java
HelpWriter.java

 xxxxx@xxxxx  2001-01-30Gilad writes, from JLS 2nd edition draft:

- A nested class is any class whose declaration occurs within the body of 
  another class or interface.
- A top-level class is class that is not a nested class.
- An inner class is a nested class that is not declared (implicitly or 
  explicitly) static.

"Nested class" is the more general term, as it applies to both
static and non-static classes.  Therefore, wherever javadoc uses "inner class", it should be replaced by "nested class"

For example, "Inner Class Summary" should become "Nested Class Summary"
since it can contain both static and non-static classes:

http://java.sun.com/products/jdk/1.2/docs/api/javax/swing/Box.html

See suggested fix for particular places this change needs to be made.
Work Around
N/A
Evaluation
Replaced strings "Inner", "inner" and "INNER" with "Nested", "nested" and "NESTED" respectively in the following files:

standard.properties
ClassSubWriter.java
ClassWriter.java
HtmlStandardWriter.java
HelpWriter.java

 xxxxx@xxxxx  2001-01-30

This is an important change.
Unfortunately it also applies to the doclet API which 
has the method "innerClasses" - we may at some point
need to spin that part off as a different bug.
 xxxxx@xxxxx  2000-01-25
Comments
  
  Include a link with my name & email   


PLEASE NOTE: JDK6 is formerly known as Project Mustang