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-8308987: Update java.lang.Class to use javadoc snippets #14194

Closed
wants to merge 2 commits into from

Conversation

jddarcy
Copy link
Member

@jddarcy jddarcy commented May 27, 2023

Straightforward doc refactoring to use snippets.


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-8308987: Update java.lang.Class to use javadoc snippets

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 14194

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

Using diff file

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

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented May 27, 2023

👋 Welcome back darcy! 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 May 27, 2023
@openjdk
Copy link

openjdk bot commented May 27, 2023

@jddarcy 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 May 27, 2023
@mlbridge
Copy link

mlbridge bot commented May 27, 2023

Webrevs

* {@code Class t = Class.forName("java.lang.Thread")}
* </blockquote>
* {@snippet lang="java" :
* Class<?> t = Class.forName("java.lang.Thread")
Copy link
Member

Choose a reason for hiding this comment

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

This should have a final semicolon, as it's already a variable declaration and initialization.

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure; will fix in next push. Thanks.

* </blockquote>
* {@snippet lang="java" :
* Class.forName("Foo", true, this.getClass().getClassLoader())
* }
Copy link
Contributor

Choose a reason for hiding this comment

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

Not important but there are at least 3 different indentation widths in the update. Does it look okay in the generated javadoc?

Copy link
Member Author

Choose a reason for hiding this comment

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

The previous blockquote tag normalized the space -- adjusted the leading whitespace to be consistent.

@openjdk
Copy link

openjdk bot commented May 30, 2023

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

8308987: Update java.lang.Class to use javadoc snippets

Reviewed-by: alanb

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

  • 04b0e78: 8307648: java/net/httpclient/ExpectContinueTest.java timed out
  • 6b90b05: 8297878: KEM: Implementation
  • 21af8ba: 8290499: new File(parent, "/") breaks normalization – creates File with slash at the end
  • 804f198: 8308992: New test TestHFA fails with zero
  • fb0b1f0: 8051725: Improve expansion of Conv2B nodes in the middle-end
  • 3eced01: 8304074: [JMX] Add an approximation of total bytes allocated on the Java heap by the JVM
  • 15e0285: 8309110: Build failure after JDK-8307795 due to warnings in micro-benchmark StoreMaskTrueCount.java
  • 4526282: 8308977: gtest:codestrings fails on riscv
  • f600d03: 8307795: AArch64: Optimize VectorMask.truecount() on Neon
  • 07f2070: 8309095: Remove UTF-8 character from TaskbarPositionTest.java
  • ... and 32 more: https://git.openjdk.org/jdk/compare/46c4da7fddb8103934f2a90b4456a5ce6ed3467c...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.

➡️ 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 May 30, 2023
@jddarcy
Copy link
Member Author

jddarcy commented May 30, 2023

/integrate

@openjdk
Copy link

openjdk bot commented May 30, 2023

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

  • 04b0e78: 8307648: java/net/httpclient/ExpectContinueTest.java timed out
  • 6b90b05: 8297878: KEM: Implementation
  • 21af8ba: 8290499: new File(parent, "/") breaks normalization – creates File with slash at the end
  • 804f198: 8308992: New test TestHFA fails with zero
  • fb0b1f0: 8051725: Improve expansion of Conv2B nodes in the middle-end
  • 3eced01: 8304074: [JMX] Add an approximation of total bytes allocated on the Java heap by the JVM
  • 15e0285: 8309110: Build failure after JDK-8307795 due to warnings in micro-benchmark StoreMaskTrueCount.java
  • 4526282: 8308977: gtest:codestrings fails on riscv
  • f600d03: 8307795: AArch64: Optimize VectorMask.truecount() on Neon
  • 07f2070: 8309095: Remove UTF-8 character from TaskbarPositionTest.java
  • ... and 32 more: https://git.openjdk.org/jdk/compare/46c4da7fddb8103934f2a90b4456a5ce6ed3467c...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented May 30, 2023

@jddarcy Pushed as commit 1b8e6bf.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

@jddarcy jddarcy deleted the JDK-8308987 branch June 10, 2023 20:08
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
Development

Successfully merging this pull request may close these issues.

None yet

3 participants