JDK-8314489: Add javadoc index entries for java.lang.Math terms

[jddarcy]

Use of javadoc search index feature; I'll re-flow paragraphs before pushing once the wording is agreed to.

---

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-8314489: Add javadoc index entries for java.lang.Math terms (Enhancement - P4)

Reviewers

• Alan Bateman (@AlanBateman - Reviewer) ⚠️ Review applies to 0bf30783

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15322

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

Using diff file

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

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

• 02: Full - Incremental (73dfc7f6)
• 01: Full - Incremental (26438061)
• 00: Full (0bf30783)

[AlanBateman]

This looks okay to me. You might want to move the "For a" on L58 to the next line to avoid L58 stick out too much, up to you.

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

8314489: Add javadoc index entries for java.lang.Math terms

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

• 2505ceb: 8314533: ProblemList runtime/cds/appcds/customLoader/HelloCustom_JFR.java on linux-all with ZGC
• b33ff30: 8313661: [REDO] Relax prerequisites for java.base-jmod target
• 62ca001: 8313357: Revisit requiring SA tests on OSX to either run as root or use sudo
• 388dcff: 8282712: VMConnection.open() does not detect if VM failed to be created, resulting in NPE
• e8f6b3e: 8314268: Missing include in assembler_riscv.hpp
• c634bdf: 8314444: Update jib-profiles.js to use JMH 1.37 devkit
• 2b81885: 8314071: Test java/foreign/TestByteBuffer.java timed out
• 32efd23: 8311939: Excessive allocation of Matcher.groups array
• ed585d1: 8314280: StructuredTaskScope.shutdown should document that the state of completing subtasks is not defined
• 6f1071f: 8314213: DocLint should warn about unknown standard tags
• ... and 4 more: https://git.openjdk.org/jdk/compare/0c3bc71d24fa13a0b1e55541c01554cd5e124027...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.

[rgiulietti]

What about <i>semi-monotonic</i> on L.80?
Does it deserve to be tagged as <dfn> and indexed?

[jddarcy]

What about <i>semi-monotonic</i> on L.80? Does it deserve to be tagged as <dfn> and indexed?

Good idea; added. The term "IEEE 754" is already index from various section titles so I didn't add an index item for that explicitly.

[jddarcy]

This looks okay to me. You might want to move the "For a" on L58 to the next line to avoid L58 stick out too much, up to you.

Sure; I usually prefer to re-flow the paragraphs after the text changes are agreed to so the difference is easier to see along the way.

[jddarcy]

/integrate

[openjdk]

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

• 2505ceb: 8314533: ProblemList runtime/cds/appcds/customLoader/HelloCustom_JFR.java on linux-all with ZGC
• b33ff30: 8313661: [REDO] Relax prerequisites for java.base-jmod target
• 62ca001: 8313357: Revisit requiring SA tests on OSX to either run as root or use sudo
• 388dcff: 8282712: VMConnection.open() does not detect if VM failed to be created, resulting in NPE
• e8f6b3e: 8314268: Missing include in assembler_riscv.hpp
• c634bdf: 8314444: Update jib-profiles.js to use JMH 1.37 devkit
• 2b81885: 8314071: Test java/foreign/TestByteBuffer.java timed out
• 32efd23: 8311939: Excessive allocation of Matcher.groups array
• ed585d1: 8314280: StructuredTaskScope.shutdown should document that the state of completing subtasks is not defined
• 6f1071f: 8314213: DocLint should warn about unknown standard tags
• ... and 4 more: https://git.openjdk.org/jdk/compare/0c3bc71d24fa13a0b1e55541c01554cd5e124027...master

Your commit was automatically rebased without conflicts.

[openjdk]

@jddarcy Pushed as commit 3bb8afb.

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