JDK-8287100 : [spec] Clean up terminology regarding doc comment descriptions.
  • Type: Bug
  • Component: tools
  • Sub-Component: javadoc(tool)
  • Priority: P4
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2022-05-20
  • Updated: 2022-05-23
  • Resolved: 2022-05-20
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 19
19 masterFixed
Related Reports
Cloners :  
JDK-8287099 - Clean up terminology regarding doc comment descriptions.
Relates :  
JDK-8285368 - Overhaul doc-comment inheritance
Description
javadoc and doclint are inconsistent in their use of the term "description", as regards to parts of a documentation comment. This can be confusing. We should define such terms and use them consistently.

It would help to reorganize the "General Syntax" section of the Doc Comment Spec, to better define the parts of a doc comment, including the introduction of a paragraph defining "Main Description".
Comments
This cleanup is triggered by JDK-8285368.
20-05-2022