RFR: JDK-8262992: Improve `@see` output [v6]

Jonathan Gibbons jjg at openjdk.java.net
Thu May 6 20:12:58 UTC 2021

On Wed, 5 May 2021 15:09:17 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.
> Hannes Wallnöfer has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains six commits:
>  - Merge branch 'master' into JDK-8262992
>  - Put enum constants into alphabetical order.
>  - Adapt new test
>  - Merge branch 'master' into JDK-8262992
>  - Update `@see` tag in class java.security.cert.PKIXRevocationChecker
>  - JDK-8262992: Improve `@see` output

Marked as reviewed by jjg (Reviewer).


PR: https://git.openjdk.java.net/jdk/pull/2894

More information about the net-dev mailing list