> Please review a doc-only change to mostly add missing `@serial` javadoc tags. > 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. > > Apart from missing `@serial` tags, this PR also adds a `@serialData` tag to > `java.awt.datatransfer.DataFlavor.writeExternal(ObjectOutput)` that the > javadoc `-serialwarn` option complains about. This is the only change in this > PR that adds documentation text and causes a change in the generated > documentation.
Hannes Wallnöfer has updated the pull request incrementally with one additional commit since the last revision: Update @serialData text to CSR-approved version ------------- Changes: - all: https://git.openjdk.org/jdk/pull/22980/files - new: https://git.openjdk.org/jdk/pull/22980/files/c4be23a7..b686fb10 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=22980&range=01 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=22980&range=00-01 Stats: 2 lines in 1 file changed: 0 ins; 0 del; 2 mod Patch: https://git.openjdk.org/jdk/pull/22980.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22980/head:pull/22980 PR: https://git.openjdk.org/jdk/pull/22980
