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

JDK-8277028: Use service type documentation as fallback for @provides #6387

Closed
wants to merge 1 commit into from

Conversation

hns
Copy link
Member

@hns hns commented Nov 15, 2021

This is a simple change to display the first sentence of the service type description in the "Provides" section of a module page if the @provides javadoc tag does not contain a description. This is the same we handle entries in the "Uses" section when no description is available from the @uses tag. The rationale is that it is still more useful to provide generic information about the service type than nothing if no provider-specific information is available.


Progress

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

Issue

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/6387/head:pull/6387
$ git checkout pull/6387

Update a local copy of the PR:
$ git checkout pull/6387
$ git pull https://git.openjdk.java.net/jdk pull/6387/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 6387

View PR using the GUI difftool:
$ git pr show -t 6387

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/6387.diff

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Nov 15, 2021

👋 Welcome back hannesw! 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 label Nov 15, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Nov 15, 2021

@hns The following label will be automatically applied to this pull request:

  • javadoc

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 pull request command.

@openjdk openjdk bot added the javadoc label Nov 15, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Nov 15, 2021

Webrevs

Copy link
Member

@pavelrappo pavelrappo left a comment

Looks good.

I was not familiar with this part of JavaDoc. When comparing source and documentation of the JDK, I was somewhat surprised to discover that aside from tests, neither @uses nor @provides specifies the optional description.

@openjdk
Copy link

@openjdk openjdk bot commented Nov 15, 2021

@hns 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 details.

After integration, the commit message for the final commit will be:

8277028: Use service type documentation as fallback for @provides

Reviewed-by: prappo

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 1 new commit pushed to the master branch:

  • fdcd16a: 8277048: Tiny improvements to the specification text for java.util.Properties.load

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 label Nov 15, 2021
@hns
Copy link
Member Author

@hns hns commented Nov 15, 2021

Thanks for the review!

I was not familiar with this part of JavaDoc. When comparing source and documentation of the JDK, I was somewhat surprised to discover that aside from tests, neither @uses nor @provides specifies the optional description.

Well the tags are documented in the "Documentation Comment Specification for the Standard Doclet", but both @uses and @provides are used without description in a lot of code bases (including JDK). I think the reason for this is that descriptions in those tags used to be displayed in addition to the first sentence from the service documentation, which I think looked kind of wrong. See JDK-8192007 for details.

@hns
Copy link
Member Author

@hns hns commented Nov 15, 2021

/integrate

@openjdk
Copy link

@openjdk openjdk bot commented Nov 15, 2021

Going to push as commit 7fc344d.
Since your change was applied there have been 3 commits pushed to the master branch:

  • 35a831d: 8272170: Missing memory barrier when checking active state for regions
  • 02f7900: 8276932: G1: Annotate methods with override explicitly in g1CollectedHeap.hpp
  • fdcd16a: 8277048: Tiny improvements to the specification text for java.util.Properties.load

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Nov 15, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels Nov 15, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Nov 15, 2021

@hns Pushed as commit 7fc344d.

💡 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
Labels
integrated javadoc
2 participants