8346667: Doccheck: warning about missing </span> before <h2>

[nizarbenalla]

Please review this doc-only patch to avoid some unwanted failures in our HTML checks.

Javadoc wraps everything under @param in a <span>, so having an h2 tag there trips some of our tests that use html validators (html-tidy and some other tests). I believe you shouldn't have an <h2> inside of a span.

This patch moves the text about "Value-based classes and identity operations" above the @param tag, it will now be rendered at the bottom of the class documentation.

This will need to be backported to JDK 24.

TIA.

---

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-8346667: Doccheck: warning about missing </span> before <h2> (Bug - P4)

Reviewers

• Paul Sandoz (@PaulSandoz - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 22833

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back nbenalla! 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]

@nizarbenalla 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:

8346667: Doccheck: warning about missing </span> before <h2>

Reviewed-by: psandoz

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 3 new commits pushed to the master branch:

• 4d77dba: 8346576: Remove vmTestbase/gc/memory/Nio/Nio.java from test/hotspot/jtreg/ProblemList.txt
• 2649a97: 8332827: [REDO] C2: crash in compiled code because of dependency on removed range check CastIIs
• 2344a1a: 8345732: Provide helpers for using PartialArrayState

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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.

[openjdk]

@nizarbenalla To determine the appropriate audience for reviewing this pull request, one or more labels corresponding to different subsystems will normally be applied automatically. However, no automatic labelling rule matches the changes in this pull request. In order to have an "RFR" email sent to the correct mailing list, you will need to add one or more applicable labels manually using the /label pull request command.

Applicable Labels

• build
• client
• compiler
• core-libs
• graal
• hotspot
• hotspot-compiler
• hotspot-gc
• hotspot-jfr
• hotspot-runtime
• i18n
• ide-support
• javadoc
• jdk
• jmx
• kulla
• net
• nio
• security
• serviceability
• shenandoah

[nizarbenalla]

/label add core-libs

[openjdk]

@nizarbenalla
The core-libs label was successfully added.

[mlbridge]

Webrevs

• 01: Full - Incremental (bbd753f7)
• 00: Full (c86a3e53)

[PaulSandoz]

I suggest you try and move this section immediately above the @param declaration and see if that resolves things. This section was intended to be part of the class documentation.

[nizarbenalla]

Done, thanks for the suggestion. The problem seems to have gone away.

[PaulSandoz]

Thanks. Looks good.

[nizarbenalla]

Thanks for the review Paul.

/integrate

[openjdk]

Going to push as commit 054c644.
Since your change was applied there have been 9 commits pushed to the master branch:

• 2a68f74: 8346128: Comparison build fails due to difference in LabelTarget.html
• cf28fd4: 8322983: Virtual Threads: exclude 2 tests
• 85e024d: 8346605: AIX fastdebug build fails in memoryReserver.cpp after JDK-8345655
• 54f3475: 8331467: FileSystems.getDefault fails with ClassNotFoundException if custom default provider is in run-time image
• 35fafbc: 8346106: Verify.checkEQ: testing utility for recursive value verification
• b2811a0: 8340493: Fix some Asserts failure messages
• 4d77dba: 8346576: Remove vmTestbase/gc/memory/Nio/Nio.java from test/hotspot/jtreg/ProblemList.txt
• 2649a97: 8332827: [REDO] C2: crash in compiled code because of dependency on removed range check CastIIs
• 2344a1a: 8345732: Provide helpers for using PartialArrayState

Your commit was automatically rebased without conflicts.

[openjdk]

@nizarbenalla Pushed as commit 054c644.

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

[nizarbenalla]

/backport jdk jdk24

[openjdk]

@nizarbenalla the backport was successfully created on the branch backport-nizarbenalla-054c644e-jdk24 in my personal fork of openjdk/jdk. To create a pull request with this backport targeting openjdk/jdk:jdk24, just click the following link:

➡️ Create pull request

The title of the pull request is automatically filled in correctly and below you find a suggestion for the pull request body:

Hi all,

This pull request contains a backport of commit 054c644e from the openjdk/jdk repository.

The commit being backported was authored by Nizar Benalla on 20 Dec 2024 and was reviewed by Paul Sandoz.

Thanks!

If you need to update the source branch of the pull then run the following commands in a local clone of your personal fork of openjdk/jdk:

$ git fetch https://github.com/openjdk-bots/jdk.git backport-nizarbenalla-054c644e-jdk24:backport-nizarbenalla-054c644e-jdk24
$ git checkout backport-nizarbenalla-054c644e-jdk24
# make changes
$ git add paths/to/changed/files
$ git commit --message 'Describe additional changes made'
$ git push https://github.com/openjdk-bots/jdk.git backport-nizarbenalla-054c644e-jdk24