RFR: 8346667: Doccheck: warning about missing </span> before <h2> [v2]

[Nizar Benalla]

On Thu, 19 Dec 2024 17:26:50 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.
>
> Nizar Benalla has updated the pull request incrementally with two additional commits since the last revision:
> 
>  - Move value-based classes description above param tag
>  - Revert "replace use of h2 with inline css, trying to get almost the same look"
>    
>    This reverts commit c86a3e5320eb542d481dfa28fd90d0eaa1f76c29.

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

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

PR Comment: https://git.openjdk.org/jdk/pull/22833#issuecomment-2555514482