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

Hannes Wallnöfer hannesw at openjdk.org
Thu Jan 18 09:40:21 UTC 2024


On Tue, 16 Jan 2024 19:46:30 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:
>> 
>>   Consolidate TOC functionality into new TableOfContents class
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/TableOfContents.java line 83:
> 
>> 81:      * @return a content object
>> 82:      */
>> 83:     protected Content getSideBar(boolean hasFilterInput) {
> 
> (Just asking)
> 
> In other builders for "complex" content, like `Table` and `Navigation` , we have methods like `toContent` or `getContent`.  Should we follow that naming convention?  While the name `getSidebar` is certainly more descriptive, is the returned object inherently a sidebar -- or is the fact that it is a sidebar just an artifact of how we currently choose to present the content?

It is actually up to the CSS how the table of contents is rendered. I'm renaming the method to `toContent()`.

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

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


More information about the build-dev mailing list