On 8/4/20 11:20 AM, Florian Weimer wrote:
I'm not sure how recent this change is, but I noticed that "no comment" warnings are now printed for entities that are related to serialization: non-public classes which implement Serializable, and private non-transient fields in serializable classes, and named private serialization-related methods. I think it might make sense to add a few words to the warning that it's about serialization compatibility. It took me a moment to realize why javadoc was warning about these constructs.
Hi Florian, Thanks for the suggestion. This is a side-effect of a recent bug fix, that missing comments were never being detected by doclint in javadoc. This was true for all missing comments, not just for declarations and comments related to serialization. I'd be curious if you have seen the warning generated inappropriately. For example, you write: `non-public classes which implement Serializable` If the class is not being documented, you shouldn't see any warnings about anything related to the doc comments for the class. Given that this is a general message about any missing comments, it may be tricky to add additional info when the comment is related to serialization. -- Jon
