Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8220379

Fix doclint handling of headings

    XMLWordPrintable

    Details

    • Subcomponent:
    • Resolved In Build:
      b13

      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.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jjg Jonathan Gibbons
              Reporter:
              jjg Jonathan Gibbons
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: