RFR: JDK-8309471: Limit key characters in static index pages [v4]

Hannes Wallnöfer hannesw at openjdk.org
Wed Jun 7 10:45:55 UTC 2023


On Wed, 7 Jun 2023 10:27:19 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> Please review a simple change to avoid adding section index items (added in JDK-8286470) from appearing in the static index pages where the tend to cause trouble. 
>> 
>> The change is implemented by making `IndexItem.isTagItem()` behave true to its specification again and only return `true` if it actually represents a JavaDoc tag, and add a new `IndexItem.isSectionItem()` method for the new section index items. The new method is used to make sure section links are not listed in the index pages.
>
> Hannes Wallnöfer has refreshed the contents of this pull request, and previous commits have been removed. The incremental views will show differences compared to the previous content of the PR. The pull request contains one new commit since the last revision:
> 
>   Include sections in index pages but restrict key characters

I updated the pull request to limit key characters to valid Java identifier start characters in the static index pages. The asterisk character `*` is used for index items that do not contain such a character. This is in line with the previous behaviour where asterisk was used for empty strings. The test was updated to contain some headings with ordinal numbers and to check the exact HTML for the index page.

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

PR Comment: https://git.openjdk.org/jdk/pull/14312#issuecomment-1580486337


More information about the javadoc-dev mailing list