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

Kumar Srinivasan ksrini at openjdk.java.net
Tue Jan 5 19:19:58 UTC 2021


On Tue, 5 Jan 2021 17:01:56 GMT, Hannes Wallnöfer <hannesw 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.
>
> Looks good, apart from two typos in a comment.

Looks good, saw the same typos Hannes noted.

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

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


More information about the javadoc-dev mailing list