RFR: JDK-8261976: Normalize id's used by the standard doclet

Hannes Wallnöfer hannesw at openjdk.java.net
Mon Feb 22 14:43:39 UTC 2021


On Thu, 18 Feb 2021 23:55:28 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> This is a conceptually simple change to ensure that all "id"s generated by the standard doclet use `-` to separate the words of the id. The `src/` change is primarily in the recently-new `HtmlIds` class, but there was one oversight in the recent work for `HtmlIds` in `SourceToHTMLConverter`, which is now fixed.
> 
> It's notable now that all "static" ids generated by the doclet contain at least one `-`, and so never conflict with the id for any field name, which cannot contain a `-`.
> 
> The tests are updated; all tests pass, of course, including the implicit link check that is default on in almost all tests. A full doc check run on a full JDK docs build did not reveal any unexpected problems.   It wasn't clear which tests to nominate with a bug number, and so (somewhat unusually) I have added the bug number to all affected tests.

Looks good!

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

Marked as reviewed by hannesw (Reviewer).

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


More information about the javadoc-dev mailing list