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

2020-10-18 Thread Patrick Concannon 
> 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

Patrick Concannon has updated the pull request with a new target base due to a 
merge or a rebase. The incremental
webrev excludes the unrelated changes brought in by the merge/rebase. The pull 
request contains two additional commits
since the last revision:

 - Merge remote-tracking branch 'origin/master' into JDK-8253474
 - 8253474: Javadoc clean up in HttpsExchange, HttpsParameters, and HttpsServer

-

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/610/files
  - new: https://git.openjdk.java.net/jdk/pull/610/files/df06f8cf..7878b878

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=610&range=01
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=610&range=00-01

  Stats: 303208 lines in 620 files changed: 296762 ins; 3969 del; 2477 mod
  Patch: https://git.openjdk.java.net/jdk/pull/610.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/610/head:pull/610

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

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

2020-10-18 Thread Patrick Concannon 
> 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

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)

-

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/610/files
  - new: https://git.openjdk.java.net/jdk/pull/610/files/7878b878..ef5b9fa7

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=610&range=02
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=610&range=01-02

  Stats: 3 lines in 1 file changed: 1 ins; 0 del; 2 mod
  Patch: https://git.openjdk.java.net/jdk/pull/610.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/610/head:pull/610

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

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

2020-10-18 Thread Patrick Concannon 
On Mon, 12 Oct 2020 19:09:10 GMT, Daniel Fuchs  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