RFR: 8253474: Javadoc clean up in HttpsExchange, HttpsParameters, and HttpsServer

[Daniel Fuchs]

On Mon, 12 Oct 2020 13:37:04 GMT, Patrick Concannon <pconcannon at openjdk.org> wrote:

> Hi,
> 
> Could someone please review my doc-only fix for JDK-8253474: 'Javadoc clean up in HttpsExchange, HttpsParameters, and
> HttpsServer' ?
> This fix is set of formatting changes intended to clean up the javadoc of the following classes :
> 
> `com.sun.net.httpserver.HttpsExchange`
> `com.sun.net.httpserver.HttpsParameters`
> `com.sun.net.httpserver.HttpsServer`
> 
> This issue is a sub-task of [JDK-8252822](https://bugs.openjdk.java.net/browse/JDK-8252822)
> 
> Kind regards,
> Patrick

Changes requested by dfuchs (Reviewer).

src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpsExchange.java line 43:

> 41:      * Constructor for subclasses to call.
> 42:      */
> 43:     protected HttpsExchange() {}

Ah. I guess this trivial change will require a CSR...

src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpsServer.java line 48:

> 46:
> 47:     /**
> 48:      */

If you're going to write a CSR, then you could as well provide the "Constructor for subclasses to call." comment...

src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpsServer.java line 60:

> 58:      * {@link #setHttpsConfigurator(HttpsConfigurator)}.
> 59:      *
> 60:      * @throws IOException if an I/O error occurs

Third change that will need to be listed in the CSR (filling out the @throws comment)

src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpsServer.java line 81:

> 79:      *             the address
> 80:      * @param backlog the socket backlog. If this value is less than or equal to
> 81:      *               zero, then a system default value is used

There is more than one sentence here, and the second sentence is a full sentence so I believe you'll need a full-stop
at the end.

src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpsServer.java line 84:

> 82:      * @throws BindException if the server cannot bind to the requested address,
> 83:      *          or if the server is already bound
> 84:      * @throws IOException if an I/O error occurs

This one needs to be listed in the CSR too.

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

PR: https://git.openjdk.java.net/jdk/pull/610