Skip to content

8329717: Missing @since tags in elements in DocumentationTool and Taglet #18640

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

Closed
wants to merge 2 commits into from

Conversation

nizarbenalla
Copy link
Member

@nizarbenalla nizarbenalla commented Apr 5, 2024

In this PR I added an @since tag to SNIPPET_PATH and isBlockTag() as they were added in later versions

  • SNIPPET_PATH was added in JDK 18 here

  • isBlockTag() was added in JDK 15 here

This is similar to #18032


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-8329717: Missing @<!---->since tags in elements in DocumentationTool and Taglet (Bug - P4)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 18640

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Apr 5, 2024

👋 Welcome back nizarbenalla! 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
Copy link

openjdk bot commented Apr 5, 2024

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

8329717: Missing `@since` tags in elements in DocumentationTool and Taglet

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

  • ee7b2e9: 8330051: Small ObjectMonitor spinning code cleanups
  • 3e185c7: 8330154: Serial: Remove TenuredSpace::update_for_block
  • f889797: 8330463: Rename invalidate() to write_region() in ModRefBarrierSet
  • c4f5c51: 8330576: ZYoungCompactionLimit should have range check
  • 70acade: 8330339: G1: Move some public methods to private in G1BlockOffsetTable APIs
  • 35b30c8: 8330595: Invoke ObjectMethods::bootstrap method exactly
  • 3d62bbf: 8330681: Explicit hashCode and equals for java.lang.runtime.SwitchBootstraps$TypePairs
  • 5313dcc: 8330733: Generational ZGC: Remove ZBarrier::verify_old_object_live_slow_path
  • 5394f57: 8330621: Make 5 compiler tests use ProcessTools.executeProcess
  • 20546c1: 8330004: Refactor cloning down code in Split If for Template Assertion Predicates
  • ... and 271 more: https://git.openjdk.org/jdk/compare/70c8ff1c9a9adf21a16d8a6b4da1eeec65afe61d...master

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.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@pavelrappo) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot added the rfr Pull request is ready for review label Apr 5, 2024
@openjdk
Copy link

openjdk bot commented Apr 5, 2024

@nizarbenalla The following labels will be automatically applied to this pull request:

  • compiler
  • javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

@mlbridge
Copy link

mlbridge bot commented Apr 5, 2024

Webrevs

Copy link
Member

@pavelrappo pavelrappo 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.

@@ -96,6 +96,7 @@ public interface Taglet {
* @return true if this taglet supports block tags
* @implSpec This implementation returns the inverse
* result to {@code isInlineTag}.
* @since 15
Copy link
Member

Choose a reason for hiding this comment

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

Might as well insert a blank line above.

Copy link
Member Author

Choose a reason for hiding this comment

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

Done, looking at the existing source code sometimes I find a blank line and sometimes I don't.

Copy link
Member

Choose a reason for hiding this comment

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

Understood; my comment was a mild suggestion, not a requirement. I find it easier to read when @since is set off with a blank line.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Apr 5, 2024
@openjdk openjdk bot added the sponsor Pull request is ready to be sponsored label Apr 5, 2024
@openjdk
Copy link

openjdk bot commented Apr 5, 2024

@nizarbenalla
Your change (at version 0c5a300) is now ready to be sponsored by a Committer.

@nizarbenalla nizarbenalla changed the title JDK-8329717 Missing @since tags in elements in DocumentationTool and Taglet JDK-8329717 Missing @since` tags in elements in DocumentationTool and Taglet Apr 5, 2024
@openjdk openjdk bot removed sponsor Pull request is ready to be sponsored ready Pull request is ready to be integrated labels Apr 5, 2024
@nizarbenalla nizarbenalla changed the title JDK-8329717 Missing @since` tags in elements in DocumentationTool and Taglet JDK-8329717 Missing @since tags in elements in DocumentationTool and Taglet Apr 5, 2024
@openjdk openjdk bot added sponsor Pull request is ready to be sponsored ready Pull request is ready to be integrated labels Apr 5, 2024
@nizarbenalla nizarbenalla changed the title JDK-8329717 Missing @since tags in elements in DocumentationTool and Taglet JDK-8329717 Missing @since tags in elements in DocumentationTool and Taglet Apr 5, 2024
@openjdk openjdk bot removed sponsor Pull request is ready to be sponsored ready Pull request is ready to be integrated labels Apr 5, 2024
@openjdk
Copy link

openjdk bot commented Apr 5, 2024

@jonathan-gibbons This PR has not yet been marked as ready for integration.

@jonathan-gibbons
Copy link
Contributor

@nizarbenalla You need to fix the PR summary to agree with the JBS summary.

@nizarbenalla nizarbenalla changed the title JDK-8329717 Missing @since tags in elements in DocumentationTool and Taglet 8329717: Missing @since tags in elements in DocumentationTool and Taglet Apr 11, 2024
@nizarbenalla nizarbenalla changed the title 8329717: Missing @since tags in elements in DocumentationTool and Taglet 8329717: Missing @since tags in elements in DocumentationTool and Taglet Apr 19, 2024
@openjdk openjdk bot added sponsor Pull request is ready to be sponsored ready Pull request is ready to be integrated labels Apr 19, 2024
@jonathan-gibbons
Copy link
Contributor

/sponsor

@openjdk
Copy link

openjdk bot commented Apr 22, 2024

Going to push as commit 83c74d7.
Since your change was applied there have been 286 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 Apr 22, 2024
@openjdk openjdk bot closed this Apr 22, 2024
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review sponsor Pull request is ready to be sponsored labels Apr 22, 2024
@openjdk
Copy link

openjdk bot commented Apr 22, 2024

@jonathan-gibbons @nizarbenalla Pushed as commit 83c74d7.

💡 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
Development

Successfully merging this pull request may close these issues.

3 participants