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

Jonathan Gibbons jjg at openjdk.java.net
Wed Jan 6 18:34:01 UTC 2021


On Tue, 5 Jan 2021 17:00:10 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.
>
> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/Utils.java line 2689:
> 
>> 2687: 
>> 2688:     /**
>> 2689:      * Checks whether an element has an associated doc copmment.
> 
> typo: copmment

Thanks

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

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


More information about the javadoc-dev mailing list