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

Bradford Wetmore wetmore at openjdk.java.net
Mon Apr 25 23:49:57 UTC 2022


On Mon, 25 Apr 2022 21:02:05 GMT, Poonam Bajaj <poonam at openjdk.org> wrote:

> This change adds "apiNote This method is defined in Java SE 8 Maintenance Release 3." to the doc comments of the new APIs added with the following changesets in Java SE MR3 :
> 
> 1. https://hg.openjdk.java.net/jdk8u/jdk8u41/jdk/rev/b26b096d4c89
> 2. https://hg.openjdk.java.net/jdk8u/jdk8u41/jdk/rev/6bada58189de

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

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

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


More information about the jdk8u-dev mailing list