Skip to content
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

Jump to bottom

8253053: Javadoc clean up in Authenticator and BasicAuthenicator #301

Closed
wants to merge 4 commits into from
Closed

8253053: Javadoc clean up in Authenticator and BasicAuthenicator #301

wants to merge 4 commits into from

Conversation

pconcannon
Copy link
Contributor

@pconcannon pconcannon commented Sep 22, 2020 •
edited by openjdk bot

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

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8253053: Javadoc clean up in Authenticator and BasicAuthenicator

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk pull/301/head:pull/301
$ git checkout pull/301

@bridgekeeper
Copy link

bridgekeeper bot commented Sep 22, 2020

👋 Welcome back pconcannon! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr Pull request is ready for review label Sep 22, 2020
@openjdk
Copy link

openjdk bot commented Sep 22, 2020

@pconcannon The following label will be automatically applied to this pull request: net.

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 /label (add|remove) "label" command.

@openjdk openjdk bot added the net net-dev@openjdk.org label Sep 22, 2020
@mlbridge
Copy link

mlbridge bot commented Sep 22, 2020 •
edited

Webrevs

dfuch
dfuch suggested changes Sep 22, 2020
View reviewed changes
Copy link
Member

@dfuch dfuch left a 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
RogerRiggs
RogerRiggs approved these changes Sep 22, 2020
View reviewed changes
Copy link
Contributor

@RogerRiggs RogerRiggs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine. Thanks.

@openjdk
Copy link

openjdk bot commented Sep 22, 2020 •
edited

@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:

8253053: Javadoc clean up in Authenticator and BasicAuthenicator

Reviewed-by: dfuchs, rriggs, chegar, michaelm

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 master branch:

  • 840aa2b: 8253424: Add support for running pre-submit testing using GitHub Actions
  • 8e87d46: 8252857: AArch64: Shenandoah C1 CAS is not sequentially consistent
  • c2692f8: 8225329: -XX:+PrintBiasedLockingStatistics causes crash during initia…

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Sep 22, 2020
dfuch
dfuch reviewed Sep 23, 2020
View reviewed changes
Copy link
Member

@dfuch dfuch left a 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
dfuch
dfuch approved these changes Sep 25, 2020
View reviewed changes
Copy link
Member

@dfuch dfuch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good Patrick!

RogerRiggs
RogerRiggs approved these changes Sep 25, 2020
View reviewed changes
Copy link
Contributor

@RogerRiggs RogerRiggs left a 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.

@pconcannon
Copy link
Contributor Author

pconcannon commented Sep 28, 2020 •
edited

fyi, the trailing can be omitted. It is not required and the source is more readable without it.

Thanks for the tip, @RogerRiggs ! I've made that change and you can view it in the latest commit (b632807)

RogerRiggs
RogerRiggs approved these changes Sep 28, 2020
View reviewed changes
Copy link
Contributor

@RogerRiggs RogerRiggs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks

@pconcannon
Copy link
Contributor Author

/integrate

@openjdk openjdk bot closed this Sep 28, 2020
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 28, 2020
@openjdk
Copy link

openjdk bot commented Sep 28, 2020

@pconcannon Since your change was applied there have been 3 commits pushed to the master branch:

  • 840aa2b: 8253424: Add support for running pre-submit testing using GitHub Actions
  • 8e87d46: 8252857: AArch64: Shenandoah C1 CAS is not sequentially consistent
  • c2692f8: 8225329: -XX:+PrintBiasedLockingStatistics causes crash during initia…

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@RogerRiggs RogerRiggs RogerRiggs approved these changes

@ChrisHegarty ChrisHegarty ChrisHegarty approved these changes

@dfuch dfuch dfuch approved these changes

@Michael-Mc-Mahon Michael-Mc-Mahon Michael-Mc-Mahon approved these changes

Assignees
No one assigned
Labels
integrated Pull request has been integrated net net-dev@openjdk.org
Milestone
No milestone
5 participants
@pconcannon @RogerRiggs @ChrisHegarty @dfuch @Michael-Mc-Mahon