[jdk16] Integrated: JDK-8251200: False positive messages about missing comments for serialization

Jonathan Gibbons jjg at openjdk.java.net
Wed Jan 6 18:56:04 UTC 2021


On Thu, 24 Dec 2020 21:16:35 GMT, Jonathan Gibbons <jjg at openjdk.org> wrote:

> Using the `@serial` tag, a class can explicitly opt-in to being documented on the serialized form page.  However, a class that does not want to opt-in should not be required to have a doc comment, and should not trigger the "missing comment" warning if there is no comment.
> 
> The fix is to check for the presence of the comment on a class before analyzing it to see if it contains `@serial` tags.
> 
> The code in `Utils.getDocCommentTree0` is slightly refactored to allow a new predicate `hasDocCommentTree` to be added.

This pull request has now been integrated.

Changeset: eef43be7
Author:    Jonathan Gibbons <jjg at openjdk.org>
URL:       https://git.openjdk.java.net/jdk16/commit/eef43be7
Stats:     138 lines in 3 files changed: 115 ins; 21 del; 2 mod

8251200: False positive messages about missing comments for serialization

Reviewed-by: hannesw

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

PR: https://git.openjdk.java.net/jdk16/pull/70


More information about the javadoc-dev mailing list