On Wed, 9 Sep 2020 12:14:28 GMT, Patrick Concannon <pconcan...@openjdk.org> wrote:
>> Hi, >> >> Could someone please review my doc-only fix for JDK-8251496 - ‘Fix doclint >> warnings in jdk.net.httpserver’ ? >> >> This fix addresses the warnings generated by `javadoc -Xdoclint` due to >> missing/incomplete API documentation for >> several classes within `jdk.net.httpserver`. >> Kind regards, >> Patrick > > Patrick Concannon has updated the pull request incrementally with one > additional commit since the last revision: > > 8251496: reworded abstract cstr comments; removed unnecessary punctuation The @param and @return lines that start with a capital letter seem out of place. The contents of most @tags are usually phrases without capitalization or period. src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java line 75: > 73: > 74: /** > 75: * returns the response code to send to the client Initial Capital and add a period please. src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java line 101: > 99: } > 100: /** > 101: * returns the authenticated user Principal Capitalize and add a period. Check all the method for the first line comments. src/jdk.httpserver/share/classes/com/sun/net/httpserver/HttpPrincipal.java line 74: > 72: > 73: /** > 74: * returns the username this object was created with. Capitalize and add a period. Please check all methods. ------------- Changes requested by rriggs (Reviewer). PR: https://git.openjdk.java.net/jdk/pull/81
