United StatesChange Country, Oracle Worldwide Web Sites Communities I am a... I want to...
JDK-4307151 : stddoclet: should use "nested classes" rather than "inner classes"

Details
Type:
Bug
Submit Date:
2000-01-25
Status:
Resolved
Updated Date:
2014-05-05
Project Name:
JDK
Resolved Date:
2001-03-17
Component:
tools
OS:
solaris_2.6
Sub-Component:
javadoc(tool)
CPU:
sparc
Priority:
P4
Resolution:
Fixed
Affected Versions:
1.2.0
Fixed Versions:
1.4.0 (beta)

Related Reports

Sub Tasks

Description
Gilad 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.

                                    

Comments
CONVERTED DATA

BugTraq+ Release Management Values

COMMIT TO FIX:
merlin-beta

FIXED IN:
merlin-beta

INTEGRATED IN:
merlin-beta


                                     
2004-06-14
SUGGESTED FIX

In this file:
/src/share/classes/com/sun/tools/doclets/standard/resources

there are 5 places to change "inner" to "nested"

doclet.navInner=INNER
doclet.Inner_Class_Summary=Inner Class Summary
doclet.Inner_Classes_Inherited_From_Class=Inner classes inherited from class {0}
doclet.Help_line_6=Each class, interface, inner class and inner interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
                                     
2004-06-11
PUBLIC COMMENTS

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

jamie.ho@Eng 2001-01-30
                                     
2001-01-30
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

jamie.ho@Eng 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.
robert.field@Eng 2000-01-25
                                     
2000-01-25



Hardware and Software, Engineered to Work Together