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

Move the section for the description of a type "up" a bit.

    Details

    • Type: Enhancement
    • Status: New
    • Priority: P3
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: tools

      Description

      HTML sections (<section>) normally include a heading (<h1> etc)

      On the page for the doc of a type (class, interface, etc) the primary content of the page begins with a header and heading, followed by a section that contains the content derived from the doc comment for the type.

      While there might be a bigger discussion about how to mark/enclose content derived from the doc comment, a short term solution would be to move the <section> tag "up a bit. In terms of the HTML file, this is literally moving "<section> up a few lines; in terms of the tree structure, it means moving it up a few nodes if possible, or else moving the header/heading down into the section.

      See attached screenshot.

        Attachments

          Activity

            People

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

              Dates

              • Created:
                Updated: