8342698: Fix order of @param tags in module java.base

[hns]

Please review a doc-only change to fix the order of javadoc @param tags in module java.base.

We are working on a javadoc feature to add an opt-in doclint warning for @param tags that don't match the order of parameters in the documented element. The warning will be enabled in OpenJDK builds and covers all uses of the @param tag, i.e. parameters of executable elements, type parameters, and record components.

---

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-8342698: Fix order of @param tags in module java.base (Sub-task - P4)

Reviewers

• Iris Clark (@irisclark - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 21611

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

Using diff file

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

Webrev

Link to Webrev Comment

[bridgekeeper]

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

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

8342698: Fix order of @param tags in module java.base

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

• 37aa320: 8342376: More reliable OOM handling in ExceptionDuringDumpAtObjectsInitPhase test
• 18bcbf7: 8341052: SHA-512 implementation using SHA-NI
• 54a744b: 8340553: ZipEntry field validation does not take into account the size of a CEN header
• 18b55ce: 8342653: Fix minor doc issues in AnnotatedElement
• 153ad91: 8338126: C2 SuperWord: VectorCastF2HF / vcvtps2ph produces wrong results for vector length 2
• 80ec552: 8328528: C2 should optimize long-typed parallel iv in an int counted loop
• 330f2b5: 8342295: compiler/jvmci/TestJVMCISavedProperties.java fails due to garbage in output
• 1f35748: 8342102: ZGC: Optimize copy constructors in ZPhysicalMemory
• 66ddaaa: 8340241: RISC-V: Returns mispredicted
• 07f550b: 8340818: Add a new jtreg test root to test the generated documentation
• ... and 4 more: https://git.openjdk.org/jdk/compare/680dc5d896f4f7b01b3cf800d548e32bb2ef8c81...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]

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

• core-libs
• security

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 (223c8600)

[irisclark]

Confirmed that these changes simply re-order existing @param tag declarations.

If this corresponds to all the problems in java.base, I'm impressed that there are so few of them.

[hns]

Thanks for the review!

If this corresponds to all the problems in java.base, I'm impressed that there are so few of them.

There are a bit more in other modules, which is why I though it was a good idea to split it up into subtasks.

[hns]

/integrate

[openjdk]

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

• 51a7ff6: 8335271: Specify the MessageFormat ArgumentIndex Implementation Limit
• 52d752c: 8339507: Test generation tool and gtest for testing APX encoding of extended gpr instructions
• 37aa320: 8342376: More reliable OOM handling in ExceptionDuringDumpAtObjectsInitPhase test
• 18bcbf7: 8341052: SHA-512 implementation using SHA-NI
• 54a744b: 8340553: ZipEntry field validation does not take into account the size of a CEN header
• 18b55ce: 8342653: Fix minor doc issues in AnnotatedElement
• 153ad91: 8338126: C2 SuperWord: VectorCastF2HF / vcvtps2ph produces wrong results for vector length 2
• 80ec552: 8328528: C2 should optimize long-typed parallel iv in an int counted loop
• 330f2b5: 8342295: compiler/jvmci/TestJVMCISavedProperties.java fails due to garbage in output
• 1f35748: 8342102: ZGC: Optimize copy constructors in ZPhysicalMemory
• ... and 6 more: https://git.openjdk.org/jdk/compare/680dc5d896f4f7b01b3cf800d548e32bb2ef8c81...master

Your commit was automatically rebased without conflicts.

[openjdk]

@hns Pushed as commit 97c9212.

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