RFR: JDK-8275199: Bogus warning generated for serializable records

[Jonathan Gibbons]

On Fri, 22 Oct 2021 00:12:04 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> Please review a trivial fix and simple test for DocLint and serializable records.
> 
> Although the original JBS issue was somewhat confused, the underlying cause of the test case is that `javadoc`/`DocLint` was checking the comments on the private internal fields, prior to writing the fields in the "Serialized Form" page.  Since the serialized form is defined to be exactly the record components, there is no need to document the fields, as explained in section 1.13, Serialization of Records. 
> https://docs.oracle.com/en/java/javase/17/docs/specs/serialization/serial-arch.html#serialization-of-records
> 
>> Documenting serializable fields and data for record classes is unnecessary, since there is no variation in the serial form, other than whether a substitute or replacement object is used.

Reverting to draft, while we investigate an alternate solution.

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

PR: https://git.openjdk.java.net/jdk/pull/6071