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

[Patrick Concannon]

On Mon, 12 Oct 2020 19:09:10 GMT, Daniel Fuchs <dfuchs at openjdk.org> wrote:

>> Patrick Concannon has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   8253474: Comment added to default constructor; fixed punctuation in create(InetSocketAddress, int)
>
> 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...

Comment added. It can be viewed in commit:
https://github.com/openjdk/jdk/pull/610/commits/ef5b9fa75886007484f15d74ddf2529f4054ee66

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

Punctuation added. You can view the change in commit:
https://github.com/openjdk/jdk/pull/610/commits/ef5b9fa75886007484f15d74ddf2529f4054ee66

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

I've created a CSR to track these changes as suggested. You can view it here:
https://bugs.openjdk.java.net/browse/JDK-8254968

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

Change has been noted in CSR (https://bugs.openjdk.java.net/browse/JDK-8254968)

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

Change noted in CSR (https://bugs.openjdk.java.net/browse/JDK-8254968)

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

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