On Mon, 24 Feb 2025 13:03:38 GMT, David Beaumont <d...@openjdk.org> wrote:

>> src/java.logging/share/classes/java/util/logging/Handler.java line 47:
>> 
>>> 45:  *
>>> 46:  * <h2>Subclass Implementation Notes</h2>
>>> 47:  *
>> 
>> Have you looked at how this is rendered in the generated API documentation 
>> when loaded up in the browser?
>> 
>> I mean `@implNote` is usually a section on its own, so I am unsure whether 
>> lines 46-47 above should be moved inside the `@implNote` section or simply 
>> removed. Or maybe it's OK to leave them there - but I am afraid it would 
>> appear as an empty subsection in the normative API documentation.
>
> You're right, it looks wrong with the `<h2>` and the @implNote. I'll just 
> remove the `<h2>`.
> I hadn't appreciated that the note would have its own section. Thanks for 
> spotting.
> It also seems that you can only add one annotation per JavaDoc entry, so I 
> removed the 2nd.

I've asked on the CSR if this should be @implNote or @implSpec.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/23491#discussion_r1967607215

Reply via email to