RFR: JDK-8326089: Text incorrectly placed in breadcrumbs list in generated docs

Jonathan Gibbons jjg at openjdk.org
Tue Feb 20 18:53:56 UTC 2024


On Tue, 20 Feb 2024 18:47:51 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Please review a simple change to avoid placing non-list content in the breadcrumb navigation bar. The solution I chose is to use the ` > ` separator as list marker for all list items except the first one using the `list-style-type` CSS property. An alternative solution would have been to add the separator character to the list item content, but I think its role is that of a list marker rather than list content.
>> 
>> The visual presentation is very close to the previous solution with tiny bit more spacing between list items.
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Navigation.java line 536:
> 
>> 534: 
>> 535:         // Add the breadcrumb navigation links if present.
>> 536:         var breadcrumbNav = HtmlTree.OL(HtmlStyle.subNavList);
> 
> Why is it `OL` not `UL` ?

OK, after googling a bit, I guess that `OL` is correct and that `OL` does not inherently mean _numbered_

And, I like using `>` as a list marker, and not adding it as content.

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/17917#discussion_r1496337225


More information about the javadoc-dev mailing list