dcsimg

How do I use the @serialData javadoc tag?

Tim Rohaly

The @serialData javadoc tag is used to document methods which generate a serialization format other than the default. In particular, @serialData is typically used to document the writeExternal() method of Externalizable class es and the writeObject method of Serializable classes. It is followed by a free-form description of the data sent to the serialization stream; this should include the order, type, and description of the data. The data description may span more than one line, and may include HTML tags.