<Beans Dev> RFR: 8251123: doclint warnings about missing javadoc tags and comments

Phil Race prr at openjdk.java.net
Fri Oct 2 19:48:40 UTC 2020


On Fri, 2 Oct 2020 18:35:25 GMT, Phil Race <prr at openjdk.org> wrote:

>> We have a number of missing javadoc tags and comments in the desktop module.
>> Most of the missing comments are related to the serialized form.
>> 
>> The fix:
>>   - Adds missing comments to the non-static/non-transient fields(even private) of the "serializable" classes
>>   - Adds comments to the "serializable" classes even if those classes are non-public
>>   - Fixes references/adds missing tags to the special methods(like readObject/writeObject)
>>   - Delete the java.awt.PeerFixer class.
>> 
>> I need advice about what exact change should be reviewed in  the CSR(except PeerFixer removal)
>> 
>> Note that in some cases I added the comments to the "implementation details", so I did not specify it fully.
>> 
>> The old review request:
>> https://mail.openjdk.java.net/pipermail/beans-dev/2020-August/000423.html
>
> I think the main thing here is I would separate out removing the duplicate PeerFixer into a new bug.
> 
> I also see that the CSR is still just a pure template.

> I need advice about what exact change should be reviewed in the CSR(except PeerFixer removal)

Probably almost all of it.

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

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


More information about the beans-dev mailing list