<Beans Dev> RFR: 8251123 doclint warnings about missing javadoc tags and comments
philip.race at oracle.com
Mon Aug 24 19:43:31 UTC 2020
On 8/9/20, 3:16 AM, Sergey Bylokhov wrote:
> Please review the fix for jdk/client.
> Bug: https://bugs.openjdk.java.net/browse/JDK-8251123
> Fix: http://cr.openjdk.java.net/~serb/8251123/webrev.01
> We have a number of missing javadoc tags and comments in the desktop
> 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
> Also, I made additional changes:
> - In one class to suppress the warning I have made two constants static:
This (above) would affect the serialised form so I am not sure about the
> - Adds @Deprecated(forRemoval = true) to the PeerFixer class:
> I think we should delete this class, so to not missing this in
> future I added
> this tag, or could I delete them right now?
I can't see one or two releases making a difference relative to JDK 1.0
So right now would be fine but it still needs a CSR.
> I also would like to clarify the status of unused fields, like:
> warning: no comment
> private int checkboxMenuItemSerializedDataVersion = 1;
> Could I add "@Deprecated(forRemoval = true)" to them as well, or could
> I delete them right now?
Wouldn't that immediately break serialization w.r.t JDK 15 ?
> Note that in some cases I added the comments to the "implementation
> details", so I did not specify it fully.
More information about the beans-dev