RFR: JDK-8253559: The INDEX page should link to Serialized Form and Constant Values pages [v2]

[Jonathan Gibbons]

On Thu, 15 Oct 2020 14:35:23 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> Jonathan Gibbons has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   Remove redundant field
>>   (There is an equivalent field in `HtmlDocletWriter`)
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/DeprecatedListWriter.java line 308:
> 
>> 306:             configuration.mainIndex.add(IndexItem.of(IndexItem.Category.MEMBERS,
>> 307:                     resources.getText("doclet.Deprecated_API"), path));
>> 308:         }
> 
> `IndexItem.Category.MEMBERS` is probably not the correct category to use for the Deprecated API page, and we should
> choose a fitting category because these summary page items will end up in the search index (see my comment in
> `IndexItem#add`)

Agreed. Now that you raise the issue, I realize that we should only use MODULE/PACKAGE/TYPES/MEMBERS for the
appropriate kinds of elements, and should use TAGS for all "plain text" entries.

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

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