<i18n dev> RFR: 8251123: doclint warnings about missing javadoc tags and comments

Phil Race prr at openjdk.java.net
Fri Oct 2 18:24:41 UTC 2020

On Fri, 25 Sep 2020 21:45:39 GMT, Sergey Bylokhov <serb 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

src/java.desktop/share/classes/javax/imageio/metadata/IIOMetadataNode.java line 44:

> 42: /**
> 43:  * A {@code IIODOMException} is thrown by the {@code IIOMetadataNode} in
> 44:  * "exceptional" circumstances.

"A" -> "An"


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

More information about the i18n-dev mailing list