RFR: 8253053: Javadoc clean up in Authenticator and BasicAuthenicator

[Daniel Fuchs]

On Tue, 22 Sep 2020 15:13:27 GMT, Patrick Concannon <pconcannon at openjdk.org> wrote:

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

The first sentence in an API documentation comment should be a full sentence.

src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java line 73:

> 71:
> 72:         /**
> 73:          * returns the response code to send to the client

I'd prefer to make this a full sentence:
`* Returns the response code to send to the client.`

src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java line 99:

> 97:         }
> 98:         /**
> 99:          * returns the authenticated user Principal

`* Returns the authenticated user {@code Principal}.`

src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java line 131:

> 129:
> 130:         /**
> 131:          * returns the response code to send to the client

`* Returns the response code to send to the client.`

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

Changes requested by dfuchs (Reviewer).

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