8356555: Incorrect use of {@link} in BigDecimal

[jddarcy]

Fix javadoc tags.

---

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-8356555: Incorrect use of {@link} in BigDecimal (Sub-task - P4)

Reviewers

• Iris Clark (@irisclark - Reviewer) Review applies to d1c2345a
• Brian Burkhalter (@bplb - Reviewer)
• Nizar Benalla (@nizarbenalla - Committer)
• Chen Liang (@liach - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25131

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 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]

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

8356555: Incorrect use of {@link} in BigDecimal

Reviewed-by: bpb, nbenalla, liach, iris

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

• dd25799: 8356212: runtime/cds/appcds/LotsOfSyntheticClasses.java timed out with -XX:+AOTClassLinking
• 5f00c87: 8356450: NPE in CLDRTimeZoneNameProviderImpl for tzdata downgrades after JDK-8342550
• 0e0bd64: 8356441: IllegalStateException in RichDiagnosticFormatter after JDK-8355065
• ... and 17 more: https://git.openjdk.org/jdk/compare/24d84cf66a47e10002a836275794f3f17e147c99...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]

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

[mlbridge]

Webrevs

• 01: Full - Incremental (212261bd)
• 00: Full (d1c2345a)

[bplb]

Looks fine.

[nizarbenalla]

I think this looks good.

[nizarbenalla]

I just noticed there are a couple more javadoc tags that need to be fixed in this class, I still see two more warnings. I should have included these in the JBS issue when filling it.

src/java.base/share/classes/java/math/BigDecimal.java:363: warning: reference to non-visible type: BigDecimal.scale (use -protected or -private options to document non-public types)
     * The scale of this BigDecimal, as returned by {@link #scale}.
                                                    ^
src/java.base/share/classes/java/math/BigDecimal.java:366: warning: reference to non-visible type: BigDecimal.scale (use -protected or -private options to document non-public types)
     * @see #scale
       ^
       ```

[jddarcy]

I just noticed there are a couple more javadoc tags that need to be fixed in this class, I still see two more warnings. I should have included these in the JBS issue when filling it.

src/java.base/share/classes/java/math/BigDecimal.java:363: warning: reference to non-visible type: BigDecimal.scale (use -protected or -private options to document non-public types)
     * The scale of this BigDecimal, as returned by {@link #scale}.
                                                    ^
src/java.base/share/classes/java/math/BigDecimal.java:366: warning: reference to non-visible type: BigDecimal.scale (use -protected or -private options to document non-public types)
     * @see #scale
       ^
       ```

Okay; I'll add a fix for that, although the javadoc text is one a private field so is not generated by default.

[nizarbenalla]

Looks good!

[jddarcy]

/integrate

[openjdk]

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

• dd25799: 8356212: runtime/cds/appcds/LotsOfSyntheticClasses.java timed out with -XX:+AOTClassLinking
• 5f00c87: 8356450: NPE in CLDRTimeZoneNameProviderImpl for tzdata downgrades after JDK-8342550
• 0e0bd64: 8356441: IllegalStateException in RichDiagnosticFormatter after JDK-8355065
• ... and 17 more: https://git.openjdk.org/jdk/compare/24d84cf66a47e10002a836275794f3f17e147c99...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jddarcy Pushed as commit bed29a0.

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