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

Nizar Benalla nbenalla at openjdk.org
Fri Dec 20 10:22:41 UTC 2024


On Thu, 19 Dec 2024 16:48:27 GMT, Nizar Benalla <nbenalla at openjdk.org> wrote:

> 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.

This pull request has now been integrated.

Changeset: 054c644e
Author:    Nizar Benalla <nbenalla at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/054c644ea6ea38e54abc81e231977106d04bb69e
Stats:     6 lines in 1 file changed: 3 ins; 2 del; 1 mod

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

Reviewed-by: psandoz

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

PR: https://git.openjdk.org/jdk/pull/22833


More information about the core-libs-dev mailing list