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

refactor/simplify structure of docs generated by javadoc

    XMLWordPrintable

Details

    • Enhancement
    • Resolution: Fixed
    • P3
    • 22
    • 13
    • tools

    Description

      Pages generated by javadoc are both unnecessarily complicated and do not leverage semantic structuring.

      Each block of documentation that is the documentation for a declaration (i.e. an element in the API) should be enclosed in a `<main>` or `<section>` element whose `class` attribute indicates the kind of declaration (i.e. the elementKind) and whose `id` attribute identifies the declaration ... meaning, the name for most elements, or the name and parameters for executable elements. The top level declaration for each page should put the information in the `<main>` element; the declaration for enclosed members should put the information in `<section>` elements.

      Attachments

        Issue Links

          Activity

            People

              jjg Jonathan Gibbons
              jjg Jonathan Gibbons
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: