8304989: unnecessary dash in @param gives double-dash in docs

[jaikiran]

Can I please get a review of this trivial doc-only change that addresses https://bugs.openjdk.org/browse/JDK-8304989?

I ran make docs-image with this change and the generated javadocs look fine.

---

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-8304989: unnecessary dash in @param gives double-dash in docs

Reviewers

• Lance Andersen (@LanceAndersen - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 13204

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

Using diff file

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

[bridgekeeper]

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

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

• core-libs
• net

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

• 00: Full (1f1d6ce0)

[openjdk]

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

8304989: unnecessary dash in @param gives double-dash in docs

Reviewed-by: lancea

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

• cddaf68: 8304962: sun/net/www/http/KeepAliveCache/B5045306.java: java.lang.RuntimeException: Failed: Initial Keep Alive Connection is not being reused
• a06f461: 8303214: Typo in java.util.Collections#synchronizedNavigableMap javadoc

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.

[jaikiran]

Thank you Lance for the review.

[jaikiran]

/integrate

[openjdk]

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

• 395a4ce: 8304591: (fs) UnixPath.stringValue need not be volatile
• 60640a2: 8300979: Lazily initialize (byte, char)arr in java.io.DataInputStream
• cddaf68: 8304962: sun/net/www/http/KeepAliveCache/B5045306.java: java.lang.RuntimeException: Failed: Initial Keep Alive Connection is not being reused
• a06f461: 8303214: Typo in java.util.Collections#synchronizedNavigableMap javadoc

Your commit was automatically rebased without conflicts.

[openjdk]

@jaikiran Pushed as commit c90699e.

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