JDK-8272944: Use snippets in jdk.javadoc documentation

[jonathan-gibbons]

Please review a patch to convert an example in the jdk.javadoc documentation to use snippets instead of raw HTML and/or {@code }. There are some minor tweaks to the text of the example, but no changes to the normative specification of the package.

Given that the example is in package-info.java, a minor change is required in JavacElements to ensure that the package symbol is completed (i.e. the package-info.java file has been read) when accessing the PackageElement.

---

Progress

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

Issue

• JDK-8272944: Use snippets in jdk.javadoc documentation

Reviewers

• Hannes Wallnöfer (@hns - Reviewer) ⚠️ Review applies to f99df7f

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 6685

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

Using diff file

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

[bridgekeeper]

👋 Welcome back jjg! 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]

@jonathan-gibbons 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]

Webrevs

• 01: Full - Incremental (b3609ed3)
• 00: Full (f99df7fc)

[hns]

Looks good!

Please fix wrong attribute name spotted by @FrauBoes.

[openjdk]

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

8272944: Use snippets in jdk.javadoc documentation

Reviewed-by: hannesw

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

• 3e93e0b: 8276769: -Xshare:auto should tolerate problems in the CDS archive
• 79165b7: 8278324: Update the --generate-cds-archive jlink plugin usage message
• 40d726b: 8278310: Improve logging in CDS DynamicLoaderConstraintsTest.java
• e4852c6: 8277998: runtime/cds/appcds/loaderConstraints/DynamicLoaderConstraintsTest.java#custom-cl-zgc failed "assert(ZAddress::is_marked(addr)) failed: Should be marked"
• 37921e3: 8269258: java/net/httpclient/ManyRequestsLegacy.java failed with connection timeout
• fd8cb2d: 8278346: java/nio/file/Files/probeContentType/Basic.java fails on Linux SLES15 machine
• e5cb84e: 8278336: Use int64_t to represent byte quantities consistently in JfrObjectAllocationSample
• 54993b1: 8278309: [windows] use of uninitialized OSThread::_state
• 10e0318: 8278158: jwebserver should set request timeout
• 5dcdee4: 8262341: Refine identical code in AddI/LNode.
• ... and 159 more: https://git.openjdk.java.net/jdk/compare/560f9c937233d548ef8db8cd9044fdc6c4cefe41...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.

[jonathan-gibbons]

/integrate

[openjdk]

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

• fb11d8f: 8272945: Use snippets in java.compiler documentation
• 42d9b1b: 8277106: Cannot compile certain sources with --release
• ba86dd4: 8278445: ProblemList tools/jpackage/share/IconTest.java on macosx-x64
• 92aa75b: 8274903: Zero: Support AsyncGetCallTrace
• 8345453: 8272392: Lanai: SwingSet2. Black background on expanding tree node
• 9b74749: 8276660: Scalability bottleneck in java.security.Provider.getService()
• 2478158: 8277361: java/nio/channels/Channels/ReadXBytes.java fails with OOM error
• 8af3b27: 8277850: C2: optimize mask checks in counted loops
• 3e93e0b: 8276769: -Xshare:auto should tolerate problems in the CDS archive
• 79165b7: 8278324: Update the --generate-cds-archive jlink plugin usage message
• ... and 167 more: https://git.openjdk.java.net/jdk/compare/560f9c937233d548ef8db8cd9044fdc6c4cefe41...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jonathan-gibbons Pushed as commit 5a80abf.

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