New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
8253053: Javadoc clean up in Authenticator and BasicAuthenicator #301
Conversation
👋 Welcome back pconcannon! A progress list of the required criteria for merging this PR into |
@pconcannon The following label will be automatically applied to this pull request: When this pull request is ready to be reviewed, an RFR email will be sent to the corresponding mailing list. If you would like to change these labels, use the |
Webrevs
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first sentence in an API documentation comment should be a full sentence.
src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java
Outdated
Show resolved
Hide resolved
src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java
Outdated
Show resolved
Hide resolved
src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks fine. Thanks.
@pconcannon This change now passes all automated pre-integration checks. ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for more details. After integration, the commit message for the final commit will be:
You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed. At the time when this comment was updated there had been 3 new commits pushed to the
Please see this link for an up-to-date comparison between the source branch of this pull request and the ➡️ To integrate this PR with the above commit message to the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks generally good - just one minor comment below...
src/jdk.httpserver/share/classes/com/sun/net/httpserver/BasicAuthenticator.java
Outdated
Show resolved
Hide resolved
604ea45
to
cbba95f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good Patrick!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
fyi, the trailing can be omitted. It is not required and the source is more readable without it.
5d90046
to
8fc5132
Compare
8fc5132
to
f2a0bb5
Compare
Thanks for the tip, @RogerRiggs ! I've made that change and you can view it in the latest commit (b632807) |
src/jdk.httpserver/share/classes/com/sun/net/httpserver/Authenticator.java
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks
/integrate |
@pconcannon Since your change was applied there have been 3 commits pushed to the
Your commit was automatically rebased without conflicts. Pushed as commit 16b8c39. 💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored. |
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
Kind regards,
Patrick
Progress
Issue
Reviewers
Download
$ git fetch https://git.openjdk.java.net/jdk pull/301/head:pull/301
$ git checkout pull/301