RFR [15] 8238467: Clean up annotations on overridden/implemented methods

Jonathan Gibbons jonathan.gibbons at oracle.com
Tue Feb 4 19:40:05 UTC 2020


Approved.  Thanks for doing this. It may cause some short term conflicts,
but is otherwise worthwhile.

You deleted comments containing @throws in a few places, but it seems like
nothing significant was added, so OK.

-- Jon


On 2/4/20 5:21 AM, Pavel Rappo wrote:
> Hello,
>
> Please review the change for https://bugs.openjdk.java.net/browse/JDK-8238467:
>
>    http://cr.openjdk.java.net/~prappo/8238467/webrev.00/
>
> This is a blanket cleanup. The change adds missing @java.lang.Override annotations
> and removes some of the {@inheritDoc} tags. The removed {@inheritDoc} tags are
> either redundant or misplaced. Redundant {@inheritDoc} tags provide explicit
> comment inheritance, otherwise having no value. Misplaced {@inheritDoc} tags
> are used on inapplicable entities, e.g. non-inheriting, non-implementing, static,
> private methods, etc.
>
> Added @Override annotations provide compile-time checking and serve as visual
> cues to the reader. Removed {@inheritDoc} tags make the source code swell and
> sometimes confuse the reader.
>
> Thanks,
> -Pavel
>


More information about the javadoc-dev mailing list