[jdk8u-ri] RFR: 8285400: Add '@apiNote' to the APIs defined in Java SE 8 MR 3

Bradford Wetmore wetmore at openjdk.java.net
Tue Apr 26 00:41:54 UTC 2022


On Tue, 26 Apr 2022 00:28:38 GMT, Mandy Chung <mchung at openjdk.org> wrote:

>> jdk/src/share/classes/javax/net/ssl/SSLEngine.java line 1356:
>> 
>>> 1354:      *
>>> 1355:      * @apiNote This method is defined in Java SE 8 Maintenance Release 3.
>>> 1356:      *
>> 
>> IMHO, this needs a separator here to separate the existing API from the addition.  Or maybe a second `@apiNote`?   It currently renders as this:
>> 
>>     API Note:
>>     This method is defined in Java SE 8 Maintenance Release 3. This method 
>>     should be called by TLS server application...
>
> I suggest using `<p>`  to start with a new paragraph.

I'm guessing @mlchung meant `<p>`.  Her suggestion didn't render correctly.

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

PR: https://git.openjdk.java.net/jdk8u-ri/pull/7


More information about the jdk8u-dev mailing list