RFR: JDK-8275199: Bogus warning generated for serializable records [v2]

Jonathan Gibbons jjg at openjdk.java.net
Fri Oct 22 02:11:34 UTC 2021


> 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.

Jonathan Gibbons has updated the pull request incrementally with one additional commit since the last revision:

  update to show fields of serializable records in the serializable form

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

Changes:
  - all: https://git.openjdk.java.net/jdk/pull/6071/files
  - new: https://git.openjdk.java.net/jdk/pull/6071/files/900d1fb7..4e5329be

Webrevs:
 - full: https://webrevs.openjdk.java.net/?repo=jdk&pr=6071&range=01
 - incr: https://webrevs.openjdk.java.net/?repo=jdk&pr=6071&range=00-01

  Stats: 62 lines in 3 files changed: 22 ins; 22 del; 18 mod
  Patch: https://git.openjdk.java.net/jdk/pull/6071.diff
  Fetch: git fetch https://git.openjdk.java.net/jdk pull/6071/head:pull/6071

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


More information about the javadoc-dev mailing list