8347122: Add missing @serial tags to module java.desktop

[hns]

Please review a doc-only change to add missing @serial javadoc tags in module java.desktop. This is a sub-task of JDK-8286931 to allow us to re-enable the javadoc -serialwarn option in the JDK doc build, which has been disabled since JDK 19.

For private and package-private serialized fields that already have a doc comment, the main description is converted to a block tag by prepending @serial since these fields do not require a main description. For protected and public serialized fields that require a main description, an empty @serial block tag is appended to the doc comment instead. The effect is the same, as the main description is used in serial-form.html if the @serial tag is missing or empty. For those fields that do not have a doc comment, a doc comment with an empty @serial tag is added.

This change has no effect on the generated documentation (apart from muting the warnings for missing @serial tags when building documentation with -serialwarn enabled).

---

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-8347122: Add missing @serial tags to module java.desktop (Sub-task - P4)

Reviewers

• Phil Race (@prrace - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 22979

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

Using diff file

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

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

8347122: Add missing @serial tags to module java.desktop

Reviewed-by: prr

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

• df28cec: 8345144: Robot does not specify all causes of IllegalThreadStateException
• 9f3c5f9: 8344907: NullPointerException in Win32ShellFolder2.getSystemIcon when "icon" is null
• 22f70a7: 8321413: IllegalArgumentException: Code length outside the allowed range while creating a jlink image
• 3bfa952: 8283795: Add TLSv1.3 and CNSA 1.0 algorithms to implementation requirements
• 1ef77cd: 8347171: (dc) java/nio/channels/DatagramChannel/InterruptibleOrNot.java fails with virtual thread factory
• 72f1114: 8346705: SNI not sent with Java 22+ using java.net.http.HttpClient.Builder#sslParameters
• cb9a98b: 8347141: Several javac tests compile with an unnecessary -Xlint:-path flag
• f9b1133: 8346880: [aix] java/lang/ProcessHandle/InfoTest.java still fails: "reported cputime less than expected"
• 9c72ded: 8346036: Unnecessary Hashtable usage in javax.swing.text.html.parser.Entity
• 3024a73: 8345782: Refining the cases that libjsig deprecation warning is issued
• ... and 20 more: https://git.openjdk.org/jdk/compare/a641932427cbe8453130593355372837d70a098f...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:

• client
• i18n

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 (3101b1b3)

[prrace]

I did check that even without these tags, the comments appear in the serialisation spec, so this is really just a source clean up.

[hns]

/integrate

[openjdk]

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

• df28cec: 8345144: Robot does not specify all causes of IllegalThreadStateException
• 9f3c5f9: 8344907: NullPointerException in Win32ShellFolder2.getSystemIcon when "icon" is null
• 22f70a7: 8321413: IllegalArgumentException: Code length outside the allowed range while creating a jlink image
• 3bfa952: 8283795: Add TLSv1.3 and CNSA 1.0 algorithms to implementation requirements
• 1ef77cd: 8347171: (dc) java/nio/channels/DatagramChannel/InterruptibleOrNot.java fails with virtual thread factory
• 72f1114: 8346705: SNI not sent with Java 22+ using java.net.http.HttpClient.Builder#sslParameters
• cb9a98b: 8347141: Several javac tests compile with an unnecessary -Xlint:-path flag
• f9b1133: 8346880: [aix] java/lang/ProcessHandle/InfoTest.java still fails: "reported cputime less than expected"
• 9c72ded: 8346036: Unnecessary Hashtable usage in javax.swing.text.html.parser.Entity
• 3024a73: 8345782: Refining the cases that libjsig deprecation warning is issued
• ... and 20 more: https://git.openjdk.org/jdk/compare/a641932427cbe8453130593355372837d70a098f...master

Your commit was automatically rebased without conflicts.

[openjdk]

@hns Pushed as commit b335ea9.

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