-
Enhancement
-
Resolution: Duplicate
-
P3
-
None
-
13
We can/should improve the use of <section> tags within generated documentation.
Two closely-related aspects are noted here:
1. Currently, all existing uses of <section> do not identify a "class" attribute. They are all of the simple form '<section role="region">'
Specifying a class would allow the ability to use styling for the section.
2. Certain uses of <div> would be better replaced by <section>.
On the page for a class declaration, this specifically includes the <div> tags with the class of "description", "summary", "details".
3. On a class declaration page, it might be reasonable to include the inheritance section in a new section. Currently, the top level structure of a class declaration is
:div[contentContainer]
ul[inheritance]
div[description]
div[summary]
div[details]
See https://www.w3.org/TR/2011/WD-html5-20110525/sections.html#the-section-element
Note that changing <div> to <section> may require corresponding changes to the standard stylesheet.
Two closely-related aspects are noted here:
1. Currently, all existing uses of <section> do not identify a "class" attribute. They are all of the simple form '<section role="region">'
Specifying a class would allow the ability to use styling for the section.
2. Certain uses of <div> would be better replaced by <section>.
On the page for a class declaration, this specifically includes the <div> tags with the class of "description", "summary", "details".
3. On a class declaration page, it might be reasonable to include the inheritance section in a new section. Currently, the top level structure of a class declaration is
:div[contentContainer]
ul[inheritance]
div[description]
div[summary]
div[details]
See https://www.w3.org/TR/2011/WD-html5-20110525/sections.html#the-section-element
Note that changing <div> to <section> may require corresponding changes to the standard stylesheet.
- blocks
-
JDK-8219945 refactor/simplify structure of docs generated by javadoc
-
- Resolved
-