RFR: JDK-8320458: Improve structural navigation in API documentation [v2]

Hannes Wallnöfer hannesw at openjdk.org
Thu Jan 11 13:39:27 UTC 2024


On Wed, 10 Jan 2024 23:46:57 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

>> Hannes Wallnöfer has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Update src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java
>>   
>>   Co-authored-by: Andrey Turbanov <turbanoff at gmail.com>
>
> test/langtools/jdk/javadoc/doclet/testCopyFiles/TestCopyFiles.java line 60:
> 
>> 58:                 // check top navbar
>> 59:                 """
>> 60:                     <a href="../package-tree.html">Tree</a>""",
> 
> What is the significance of this filename change?

For context-specific links in the top navigation bar we always link to the target closest to the current page; for example, The "USE" link in class documentation links to the Class Use page of the current class, and the "TREE" link in files belonging to a package links to the Package Tree page. This was previously not handled correctly for package-level doc files. It is now fixed, so the test has to be updated.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/17062#discussion_r1448877285


More information about the build-dev mailing list