-
Enhancement
-
Resolution: Unresolved
-
P3
-
23
-
None
Most block tags (like `@param`, `@return`, `@throws`) have small c content, which is accommodated well in the current use of a definition list to present the information.
There are a few outliers for some tags, most notably in the `@apiNote` family, that have substantial content, including headings, tables, lists, and large preformatted elements.
At a minimum, it would be good to revise the CSS for `dl.notes` so that the `<dd>` entries are indented. Without that visual clue, it can be hard to detect where they output changes from one block tag to the next, when there are block tags with "big" elements -- especially headings.
More advanced, it might be interesting to consider a more adaptive strategy for the presentation. For example, if the output from the taglet for a block tag is deemed to be "big" (perhaps indicated by the use of significant HTML block elements) then it might be worth presenting that output outside on the main `dl.notes`, perhaps using a div section and heading.
There are a few outliers for some tags, most notably in the `@apiNote` family, that have substantial content, including headings, tables, lists, and large preformatted elements.
At a minimum, it would be good to revise the CSS for `dl.notes` so that the `<dd>` entries are indented. Without that visual clue, it can be hard to detect where they output changes from one block tag to the next, when there are block tags with "big" elements -- especially headings.
More advanced, it might be interesting to consider a more adaptive strategy for the presentation. For example, if the output from the taglet for a block tag is deemed to be "big" (perhaps indicated by the use of significant HTML block elements) then it might be worth presenting that output outside on the main `dl.notes`, perhaps using a div section and heading.
- relates to
-
JDK-8332239 Improve CSS for block tags
-
- Resolved
-