JDK-8258002 : Update "type" terminology in generated docs
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Affected Version: 16
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2020-12-09
  • Updated: 2021-06-22
  • Resolved: 2020-12-18
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 Availability Release.

To download the current JDK release, click here.
JDK 16 JDK 17
16 b30Fixed 17Fixed
Related Reports
Blocks :  
Relates :  
Relates :  
Sub Tasks
JDK-8269412 :  
Description
We should update labels and text in javadoc-generated output to reflect the new guidelines for the terms types, classes and interfaces etc.
Comments
Changeset: c04c7e1f Author: Jonathan Gibbons <jjg@openjdk.org> Date: 2020-12-18 18:34:25 +0000 URL: https://git.openjdk.java.net/jdk16/commit/c04c7e1f
18-12-2020

Sample of javadoc text for mandated methods on enum classes: public static RoundingMode[] values() Returns an array containing the constants of this enum type, in the order they are declared. public static RoundingMode valueOf���(String name) Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
09-12-2020

From [~abuckley]: > In addition to changing "Annotation Type[s]" to "Annotation Interface[s]" throughout javadoc's output (including in the top-level "USE" and "TREE" pages), the search box's result list has a subhead "Types" that should be "Classes and Interfaces". Alex P.S. The "USE" page believes that annotation types^H^H^H^H^Hinterfaces are classes, but they have always been interfaces. Visit the javadoc for java.lang.Override, then view the USE page -- its title is "Uses of Class java.lang.Override". I know the "USE" page understands interfaces because if you visit the javadoc for java.lang.Cloneable, the USE page is titled "Uses of Interface java.lang.Cloneable".
09-12-2020

From [~darcy]: I believe the verbiage on the javadoc the compile-generated methods enum ... classes... needs updating too, values and valueOf. -Joe
09-12-2020