<i18n dev> RFR: 8347122: Add missing @serial tags to module java.desktop
Phil Race
prr at openjdk.org
Thu Jan 9 21:22:47 UTC 2025
On Wed, 8 Jan 2025 19:58:33 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:
> 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.
>
> [JDK-8286931]: https://bugs.openjdk.org/browse/JDK-8286931
>
> 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).
I did check that even without these tags, the comments appear in the serialisation spec, so this is really just a source clean up.
-------------
Marked as reviewed by prr (Reviewer).
PR Review: https://git.openjdk.org/jdk/pull/22979#pullrequestreview-2540950460
More information about the i18n-dev
mailing list