8278607: Misc issues in foreign API javadoc

[mcimadamore]

This patch fixes a number of issues and typos in the foreign API javadoc following another internal round of reviews.

---

Progress

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

Issue

• JDK-8278607: Misc issues in foreign API javadoc

Reviewers

• Athijegannathan Sundararajan (@sundararajana - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17

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

Using diff file

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

[bridgekeeper]

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

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

[mlbridge]

Webrevs

• 03: Full - Incremental (5f1ee0ed)
• 02: Full - Incremental (603df4ec)
• 01: Full - Incremental (aa74d836)
• 00: Full (011f6e5f)

[mlbridge]

Mailing list message from John Rose on core-libs-dev:

Nice work. I like this API a lot, and the doc is getting a good clear
shine on it.

The run-on sentence at the top of `<h3>Foreign addresses</h3>` needs a
bit more polish. The long parenthetical comment still reads awkwardly.
Maybe it doesn?t need parentheses any more, now that it?s part of
(or all of) its own small sentence?

On 13 Dec 2021, at 13:20, Maurizio Cimadamore wrote:

[TheMode]

Should perhaps be one :)

[sundararajana]

LGTM

[openjdk]

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

8278607: Misc issues in foreign API javadoc

Reviewed-by: sundar

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

• 918e339: 8278233: [macos] tools/jpackage tests timeout due to /usr/bin/osascript
• f48a3e8: 8278758: runtime/BootstrapMethod/BSMCalledTwice.java fails with release VMs after JDK-8262134
• 0cc989b: 8278744: KeyStore:getAttributes() not returning unmodifiable Set
• 475ec8e: 8277919: OldObjectSample event causing bloat in the class constant pool in JFR recording
• 32139c1: 8262134: compiler/uncommontrap/TestDeoptOOM.java failed with "guarantee(false) failed: wrong number of expression stack elements during deopt"
• c93b24d: 8132785: java/lang/management/ThreadMXBean/ThreadLists.java fails intermittently

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.

[sundararajana]

LGTM

[mcimadamore]

/integrate

[openjdk]

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

• 918e339: 8278233: [macos] tools/jpackage tests timeout due to /usr/bin/osascript
• f48a3e8: 8278758: runtime/BootstrapMethod/BSMCalledTwice.java fails with release VMs after JDK-8262134
• 0cc989b: 8278744: KeyStore:getAttributes() not returning unmodifiable Set
• 475ec8e: 8277919: OldObjectSample event causing bloat in the class constant pool in JFR recording
• 32139c1: 8262134: compiler/uncommontrap/TestDeoptOOM.java failed with "guarantee(false) failed: wrong number of expression stack elements during deopt"
• c93b24d: 8132785: java/lang/management/ThreadMXBean/ThreadLists.java fails intermittently

Your commit was automatically rebased without conflicts.

[openjdk]

@mcimadamore Pushed as commit d6b5544.

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