RFR: 8340565: Create separate index page for terms defined by the index tag

[Jonathan Gibbons]

On Wed, 9 Oct 2024 17:49:23 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> This change adds a conditional `search-tags.html` page to list all search tags defined by the `{@index ... }` tag. Since search tags work very similar to the `{@systemProperty ...}` tag and are internally represented by the same class I changed `SystemPropertiesWriter.java` into an abstract base class called `IndexItemListWriter.java`, with concrete subclasses for system properties and search tags.
> 
> JavaDoc also generates index items for documentation headings, these are not included in `search-tags.html`.
> 
> [This is the Search Tags page for JDK API docs](https://cr.openjdk.org/~hannesw/8340565/api.00/search-tags.html) (top-level files only).

Just asking: is it publicly documented anywhere that headings go into the interactive search? 

I guess there is a reasonably simple self-consistent rule that explicit use of `{@index}` tags go into this new page, but other items (like headings) that go into interactive search do not.  I'm trying to stay clear of even hinting that headings are treated as-if they had an implicit `{@index}` tag.

Also, note that "top-level" headings in a traditional comment for a member declaration start at `<h3>`. (For Markdown comments, all top-level headings for all declarations start at level 1.)

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

PR Comment: https://git.openjdk.org/jdk/pull/21429#issuecomment-2405510245