On Wed, 29 May 2024 19:39:14 GMT, Hannes Wallnöfer <hann...@openjdk.org> wrote:
> Please review a patch to change the breadcrumb sub-navigation in API docs to
> display nested classes as separate links.
>
> The change itself is simple, I replaced the `getBreadCrumbLink` method in
> `HtmlDocletWriter` which returned a link for a single element with a new
> `addBreadCrumbLinks` method in `Navigation` which recursively adds all
> breadcrumb links to a list. Moving the code from `HtmlDocletWriter` to
> `Navigation` allowed me to remove a lot of code because it is no longer
> necessary to override the `getNavBar` method in a lot of writer subclasses.
>
> I compared the JDI API documentation with and without this patch and there
> were no changes except for the breadcrumb links for nested classes.
Very nice!
One suggestion to improve a comment.
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Navigation.java
line 377:
> 375:
> 376: /**
> 377: * Adds a breadcrumb navigation link for {@code element} to {@code
> contents} after
grammar: change `a ... link` to plural form.
-------------
Marked as reviewed by jjg (Reviewer).
PR Review: https://git.openjdk.org/jdk/pull/19466#pullrequestreview-2089264008
PR Review Comment: https://git.openjdk.org/jdk/pull/19466#discussion_r1621365674
