RFR: 8347123: Add missing @serial tags to other modules
Hannes Wallnöfer
hannesw at openjdk.org
Thu Jan 23 16:18:46 UTC 2025
On Wed, 22 Jan 2025 20:35:22 GMT, Phil Race <prr at openjdk.org> wrote:
>> Only the `writeExternal` method is required to have a `@serialData` tag in order to keep javadoc running with `-serialwarn` option from complaining. I guess the thinking is that the `readExternal` logic can be derived from that.
>>
>> @prrace do you have any suggestions for the spec change, or are you ok with the proposed wording?
>
> There's not a great number of "good" examples of this in the JDK, so probably OK except it
> seems like most cases will do it like a normal javadoc method so you'd want an @param tag too.
>
> note : this is a desktop class, so I'm looking at this one but someone else will need to look at all the others
I've created a CSR with a slightly modified version of the text proposed in this PR:
https://bugs.openjdk.org/browse/JDK-8348408
Other doc tags such as `@param` and `@throws` are inherited from the overridden method. Also, this is the only change in this PR that modifies the serialization spec.
-------------
PR Review Comment: https://git.openjdk.org/jdk/pull/22980#discussion_r1927261011
More information about the serviceability-dev
mailing list