JDK-8220379 : Fix doclint handling of headings
  • Type: Bug
  • Component: tools
  • Sub-Component: javac
  • Affected Version: 13
  • Priority: P3
  • Status: Resolved
  • Resolution: Fixed
  • Submitted: 2019-03-08
  • Updated: 2023-09-04
  • Resolved: 2019-03-14
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 13
13 b13Fixed
Related Reports
Duplicate :  
Duplicate :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Relates :  
Description
During recent work to fix headings in generated docs, it became clear that the previous guidelines for using headings in documentation comments were flawed, *and* that doclint imperfectly checked those guidelines.

The new/revised guidelines are:

* Headings in documentation comments for all modules, packages and types (including nested types) shuld begin at <h2>.
* Headings in members should begin at <h4>.

Previously, and incorrectly, doclint assumed that all headings should begin at <h3>, and while it checked for messing headings, it did not check for low headings.
Comments
URL: http://hg.openjdk.java.net/jdk/jdk/rev/67f72165dca5 User: jjg Date: 2019-03-14 18:40:09 +0000
14-03-2019