On Wed, 9 Oct 2024 17:49:23 GMT, Hannes Wallnöfer <[email protected]> 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).
The code in the patch looks good.
I downloaded the patch and built JDK to see the results for myself. The new
page looks okay. It will take some additional effort both from jdk.javadoc and
other JDK developers later to make it more useful and less silly in its
content. For example, this should be the same item defined in two different
places:
Java language model | package javax.lang.model
Language Model | module java.compiler
Also, I assume some doubling I see in the rightmost column will go away after
#21765 has been integrated; correct?
equivalence relation | java.lang.Object.equals(Object),
java.lang.Object.equals(Object)
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/Navigation.java
line 91:
> 89: RESTRICTED,
> 90: SEARCH,
> 91: SEARCH_TAGS,
I have a sense of unease when enum constants are reordered. But it's an
internal enum class, so any effects should be confined to jdk.javadoc. Thanks
for making them properly ordered.
-------------
Marked as reviewed by prappo (Reviewer).
PR Review: https://git.openjdk.org/jdk/pull/21429#pullrequestreview-2424251525
PR Review Comment: https://git.openjdk.org/jdk/pull/21429#discussion_r1834670447
