RFR: JDK-8262992: Improve `@see` output
Daniel Fuchs
dfuchs at openjdk.java.net
Tue Mar 9 16:11:09 UTC 2021
On Tue, 9 Mar 2021 15:04:35 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:
> This changes the output for `@see` tags to a `<ul>` structure. A different CSS style is used if any of the `@see` tag labels are longer than 30 characters or contain a comma.
>
> The layout for the default CSS style is similar to the one we had so far with multiple links displayed inline and separated by commas. The CSS style for lists containing longer labels displays the list in block mode, but still separated by commas and without list markers. Note that the commas are generated via CSS in both cases.
>
> As expected, there's a lot of test churn with this change. I converted some tests to text blocks that were still using old style string concatenation. In `TestSingletonLists.java` I had to exclude `@see` lists from the singleton check as javadoc generates a "See also" item for constant field values.
Changes to `java.net.URI` look good. Don't count me as reviewer for the rest.
best regards,
-- daniel
-------------
PR: https://git.openjdk.java.net/jdk/pull/2894
More information about the javadoc-dev
mailing list