JDK-4307151 : stddoclet: should use "nested classes" rather than "inner classes"
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 1.2.0
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • OS: solaris_2.6
  • CPU: sparc
  • Submitted: 2000-01-25
  • Updated: 2014-05-05
  • Resolved: 2001-03-17
The Version table provides details related to the release that this issue/RFE will be addressed.

Unresolved : Release in which this issue/RFE will be addressed.
Resolved: Release in which this issue/RFE has been resolved.
Fixed : Release in which this issue/RFE has been fixed. The release containing this fix may be available for download as an Early Access Release or a General Availabitlity Release.

To download the current JDK release, click here.
Other
1.4.0 betaFixed
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