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

8319323: FFM: Harmonize the @throws tags in the javadocs #16478

Closed
wants to merge 3 commits into from

Conversation

minborg
Copy link
Contributor

@minborg minborg commented Nov 2, 2023

This PR proposes to harmonize the @throws tags in the javadocs for the FFM API.

The @throws tags are using a bit different principles with respect to formatting and ending with a period or not.

Looking at some prominent Java classes like List and Stream, they:

  1. Indent such that multi-line texts align with the beginning of the Exception type
  2. Do not have a period after the text.

Some of the tags in the FFM classes already conform to these bullets. This PR proposes to make them all do.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8319323: FFM: Harmonize the @throws tags in the javadocs (Sub-task - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/16478/head:pull/16478
$ git checkout pull/16478

Update a local copy of the PR:
$ git checkout pull/16478
$ git pull https://git.openjdk.org/jdk.git pull/16478/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16478

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/16478.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 2, 2023

👋 Welcome back pminborg! 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 Nov 2, 2023
@openjdk
Copy link

openjdk bot commented Nov 2, 2023

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

  • core-libs

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 core-libs core-libs-dev@openjdk.org label Nov 2, 2023
@mlbridge
Copy link

mlbridge bot commented Nov 2, 2023

Webrevs

@RogerRiggs
Copy link
Contributor

Nice to see consistency, while respecting English grammar.
If any javadoc text is a full sentence, it should end with a period. If it is a fragment, then the period is omitted.

@openjdk
Copy link

openjdk bot commented Nov 2, 2023

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

8319323: FFM: Harmonize the @throws tags in the javadocs

Reviewed-by: jvernee

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 10 new commits pushed to the master branch:

  • c788160: 8296240: Augment discussion of test tiers in doc/testing.md
  • ffaecd4: 8315364: Assert thread state invariant for JFR stack trace capture
  • 3b65b87: 8316028: Update FreeType to 2.13.2
  • 9dc40ba: 8319195: Move most tier 1 vector API regression tests to tier 3
  • f875163: 8318982: Improve Exceptions::special_exception
  • 84f4f74: 8319213: Compatibility.java reads both stdout and stderr of JdkUtils
  • 6ad093e: 8319265: TestLoadLibraryDeadlock.java fails on windows-x64 "Unable to load b.jar"
  • e6f46a4: 8317374: Add Let's Encrypt ISRG Root X2
  • e318cd2: 8316969: Improve CDS module graph support for --module option
  • 7a7b1e5: 8315890: Attempts to load from nullptr in instanceKlass.cpp and unsafe.cpp

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 Nov 2, 2023
@minborg
Copy link
Contributor Author

minborg commented Nov 3, 2023

/integrate

@openjdk
Copy link

openjdk bot commented Nov 3, 2023

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

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Nov 3, 2023
@openjdk openjdk bot closed this Nov 3, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 3, 2023
@openjdk
Copy link

openjdk bot commented Nov 3, 2023

@minborg Pushed as commit be01caf.

💡 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
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated
3 participants