RFR: 8347123: Add missing @serial tags to other modules

Phil Race prr at openjdk.org
Wed Jan 22 20:37:51 UTC 2025


On Wed, 22 Jan 2025 09:23:10 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

>> src/java.datatransfer/share/classes/java/awt/datatransfer/DataFlavor.java line 1288:
>> 
>>> 1286: 
>>> 1287:     /**
>>> 1288:      * Serializes this {@code DataFlavor}.
>> 
>> This most definitely changes the serialisation spec. So a CSR is needed.
>> Also shouldn't readExternal be updated to correspond ?
>
> 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

-------------

PR Review Comment: https://git.openjdk.org/jdk/pull/22980#discussion_r1925928563


More information about the serviceability-dev mailing list