JDK-8289332: Auto-generate ids for user-defined headings

[hns]

This is a simple change to automatically generate id attributes for HTML headers in documentation comments.

I decided to leave the functionality in HtmlDocletWriter rather than moving it to HtmlIds because it uses the same helper methods ascommentTagsToContent.

The value of the id attribute id derived from the content of the header tag with spaces and other non-word characters replaced by -. A -hdr suffix is appended to avoid collisions with other ids. If there are duplicate values an int counter is appended to make them unique.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8289332: Auto-generate ids for user-defined headings

Reviewers

• Jonathan Gibbons (@jonathan-gibbons - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/9627/head:pull/9627
$ git checkout pull/9627

Update a local copy of the PR:
$ git checkout pull/9627
$ git pull https://git.openjdk.org/jdk pull/9627/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 9627

View PR using the GUI difftool:
$ git pr show -t 9627

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/9627.diff

[bridgekeeper]

👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

@hns The following label will be automatically applied to this pull request:

• javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 01: Full - Incremental (47f2371f)
• 00: Full (eb410346)

[jonathan-gibbons]

Some inline comments/questions.

[hns]

Thanks for the review, I think I addressed all your feedback in the incremental commit.

As a corner case I removed the emptiness check for the heading text, so an empty heading will now get an id="-heading[idx]" attribute which is useless but also harmless.

[jonathan-gibbons]

yes, I like the change to move the code to allocate the id to HtmlIds

[openjdk]

@hns This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8289332: Auto-generate ids for user-defined headings

Reviewed-by: jjg

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 248 new commits pushed to the master branch:

• 0fc9263: 8291828: Reduce runtime of java.util.stream microbenchmarks
• e81210f: 8292352: 32-bit Windows build failures after JDK-8290059
• f45b840: 8292384: Convert AdapterHandlerTable to ResourceHashtable
• 0c67fba: 8289049: x86_32 build fails with GCC 11 due to newString646_US warning
• bf7d6d3: 7132413: [macosx] closed/javax/swing/AbstractButton/5049549/bug5049549.java fails on MacOS
• e230719: 8292448: Convert BitMapFragmentTable to ResourceHashtable
• f75da22: 8292395: [testbug] VectorGatherScatterTest.java fails on SVE with -XX:MaxVectorSize=8 after JDK-8288397
• 802ef38: 8292327: java.io.EOFException in InflaterInputStream after JDK-8281962
• e61f6fc: 8292362: java/lang/Thread/jni/AttachCurrentThread/AttachTest.java#id1 failed on some platforms
• 0bfb121: 8292051: jdk/internal/misc/TerminatingThreadLocal/TestTerminatingThreadLocal.java failed "AssertionError: Expected terminated values: [666] but got: []"
• ... and 238 more: https://git.openjdk.org/jdk/compare/350808a5a3cbaa097c3360bfca9af6d90f1b223b...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

[hns]

/integrate

[openjdk]

Going to push as commit 8b4e6ba.
Since your change was applied there have been 248 commits pushed to the master branch:

• 0fc9263: 8291828: Reduce runtime of java.util.stream microbenchmarks
• e81210f: 8292352: 32-bit Windows build failures after JDK-8290059
• f45b840: 8292384: Convert AdapterHandlerTable to ResourceHashtable
• 0c67fba: 8289049: x86_32 build fails with GCC 11 due to newString646_US warning
• bf7d6d3: 7132413: [macosx] closed/javax/swing/AbstractButton/5049549/bug5049549.java fails on MacOS
• e230719: 8292448: Convert BitMapFragmentTable to ResourceHashtable
• f75da22: 8292395: [testbug] VectorGatherScatterTest.java fails on SVE with -XX:MaxVectorSize=8 after JDK-8288397
• 802ef38: 8292327: java.io.EOFException in InflaterInputStream after JDK-8281962
• e61f6fc: 8292362: java/lang/Thread/jni/AttachCurrentThread/AttachTest.java#id1 failed on some platforms
• 0bfb121: 8292051: jdk/internal/misc/TerminatingThreadLocal/TestTerminatingThreadLocal.java failed "AssertionError: Expected terminated values: [666] but got: []"
• ... and 238 more: https://git.openjdk.org/jdk/compare/350808a5a3cbaa097c3360bfca9af6d90f1b223b...master

Your commit was automatically rebased without conflicts.

[openjdk]

@hns Pushed as commit 8b4e6ba.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.