Details
-
Type:
Enhancement
-
Status: New
-
Priority:
P3
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: None
-
Component/s: tools
-
Labels:
-
Subcomponent:
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.
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.
