Re: RFR: 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator [v2]
> Hi, > > Could someone please review my doc-only fix for JDK-8253473: 'Javadoc clean > up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator ' ? > > This fix is set of formatting changes intended to clean up the javadoc of the > following classes : > > `com.sun.net.httpserver.HttpHandler` > `com.sun.net.httpserver.HttpPrincipal` > `com.sun.net.httpserver.HttpContext` > `com.sun.net.httpserver.HttpsConfigurator` > > 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-8253473 - 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator - Changes: - all: https://git.openjdk.java.net/jdk/pull/810/files - new: https://git.openjdk.java.net/jdk/pull/810/files/4aec796b..63633fa4 Webrevs: - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=810&range=01 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=810&range=00-01 Stats: 16121 lines in 564 files changed: 8952 ins; 5270 del; 1899 mod Patch: https://git.openjdk.java.net/jdk/pull/810.diff Fetch: git fetch https://git.openjdk.java.net/jdk pull/810/head:pull/810 PR: https://git.openjdk.java.net/jdk/pull/810
Re: RFR: 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator [v3]
> Hi, > > Could someone please review my doc-only fix for JDK-8253473: 'Javadoc clean > up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator ' ? > > This fix is set of formatting changes intended to clean up the javadoc of the > following classes : > > `com.sun.net.httpserver.HttpHandler` > `com.sun.net.httpserver.HttpPrincipal` > `com.sun.net.httpserver.HttpContext` > `com.sun.net.httpserver.HttpsConfigurator` > > 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: 8253473: Updated the @param for HttpPrincipal::getName; fixed @code tags - Changes: - all: https://git.openjdk.java.net/jdk/pull/810/files - new: https://git.openjdk.java.net/jdk/pull/810/files/63633fa4..d8b93d01 Webrevs: - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=810&range=02 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=810&range=01-02 Stats: 3 lines in 1 file changed: 1 ins; 0 del; 2 mod Patch: https://git.openjdk.java.net/jdk/pull/810.diff Fetch: git fetch https://git.openjdk.java.net/jdk pull/810/head:pull/810 PR: https://git.openjdk.java.net/jdk/pull/810
Re: RFR: 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator [v3]
On Wed, 28 Oct 2020 14:27:38 GMT, Daniel Fuchs wrote:
>> Patrick Concannon has updated the pull request incrementally with one
>> additional commit since the last revision:
>>
>> 8253473: Updated the @param for HttpPrincipal::getName; fixed @code tags
>
> src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpPrincipal.java
> line 57:
>
>> 55: * and realm are equal to this object's username and realm. Returns
>> {@code false}
>> 56: * otherwise.
>> 57: *
>
> Isn't this missing an @param for `another` ?
Well spotted. @param added in commit d8b93d01021d696f9f5272b1e6b34750dc36bcbf
> src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpPrincipal.java
> line 78:
>
>> 76: public String getName() {
>> 77: return username;
>> 78: }
>
> Can you log a follow-up bug about this? It seems that the implementation just
> returns `username`, not `realm:username`.
I've created an issue for this as requested:
https://bugs.openjdk.java.net/browse/JDK-8255584
-
PR: https://git.openjdk.java.net/jdk/pull/810
Re: RFR: 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator [v3]
On Wed, 28 Oct 2020 14:44:55 GMT, Daniel Fuchs wrote:
>> src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpPrincipal.java
>> line 100:
>>
>>> 98: /**
>>> 99: * Returns a hashcode for this {@code HttpPrincipal}. This is
>>> calculated
>>> 100: * as (getUsername()+getRealm().hashCode().
>>
>> There is a close parenthesis missing after `getRealm()`
>
> Also `` could be replaced with `{@code }`
Closing parenthesis added and code tag changed in commit:
d8b93d01021d696f9f5272b1e6b34750dc36bcbf
-
PR: https://git.openjdk.java.net/jdk/pull/810
Re: RFR: 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator [v3]
On Thu, 29 Oct 2020 11:01:59 GMT, Patrick Concannon
wrote:
>> Hi,
>>
>> Could someone please review my doc-only fix for JDK-8253473: 'Javadoc clean
>> up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator ' ?
>>
>> This fix is set of formatting changes intended to clean up the javadoc of
>> the following classes :
>>
>> `com.sun.net.httpserver.HttpHandler`
>> `com.sun.net.httpserver.HttpPrincipal`
>> `com.sun.net.httpserver.HttpContext`
>> `com.sun.net.httpserver.HttpsConfigurator`
>>
>> 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:
>
> 8253473: Updated the @param for HttpPrincipal::getName; fixed @code tags
src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpPrincipal.java line
58:
> 56: * otherwise.
> 57: *
> 58: * @param another the object to compare this instance of {@code
> HttpPrincipal} against
And that might require a CSR...
-
PR: https://git.openjdk.java.net/jdk/pull/810
Re: RFR: 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator [v3]
On Thu, 29 Oct 2020 11:01:59 GMT, Patrick Concannon wrote: >> Hi, >> >> Could someone please review my doc-only fix for JDK-8253473: 'Javadoc clean >> up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator ' ? >> >> This fix is set of formatting changes intended to clean up the javadoc of >> the following classes : >> >> `com.sun.net.httpserver.HttpHandler` >> `com.sun.net.httpserver.HttpPrincipal` >> `com.sun.net.httpserver.HttpContext` >> `com.sun.net.httpserver.HttpsConfigurator` >> >> 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: > > 8253473: Updated the @param for HttpPrincipal::getName; fixed @code tags Marked as reviewed by dfuchs (Reviewer). - PR: https://git.openjdk.java.net/jdk/pull/810
Re: RFR: 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator [v3]
On Thu, 29 Oct 2020 11:07:35 GMT, Daniel Fuchs wrote:
>> Patrick Concannon has updated the pull request incrementally with one
>> additional commit since the last revision:
>>
>> 8253473: Updated the @param for HttpPrincipal::getName; fixed @code tags
>
> src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpPrincipal.java
> line 58:
>
>> 56: * otherwise.
>> 57: *
>> 58: * @param another the object to compare this instance of {@code
>> HttpPrincipal} against
>
> And that might require a CSR...
I've created a CSR as requested:
https://bugs.openjdk.java.net/browse/JDK-8255594
-
PR: https://git.openjdk.java.net/jdk/pull/810
Re: RFR: 8253473: Javadoc clean up in HttpHandler, HttpPrincipal, HttpContext, and HttpsConfigurator [v3]
On Thu, 29 Oct 2020 12:07:59 GMT, Patrick Concannon
wrote:
>> src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpPrincipal.java
>> line 58:
>>
>>> 56: * otherwise.
>>> 57: *
>>> 58: * @param another the object to compare this instance of {@code
>>> HttpPrincipal} against
>>
>> And that might require a CSR...
>
> I've created a CSR as requested:
> https://bugs.openjdk.java.net/browse/JDK-8255594
CSR Reviewed.
-
PR: https://git.openjdk.java.net/jdk/pull/810
