On Sun, 15 May 2022 21:16:53 GMT, Pavel Rappo <[email protected]> wrote:
> 1. One the one hand, it's not clear to me what criterion was used for adding
> `@Override` annotations. On the other hand, the more `@Override` annotations
> a codebase has, the better.
>
> 2. Have you compared the resulting documentation before and after the
> change? Aside from added `@implSpec` and `@implNote`, were there anything
> anything different?
>
> 3. I wonder if it makes sense to also reduce the size of the doc comments
> by changing explicit documentation inheritance for the `@param` and `@return`
> tags to implicit one, i.e. removing the tags on the overrider's side.
I added the `@Override` annotations to methods I reviewed and/or updated; it
was not necessarily an exhaustive process. I have not run specdiff to
double-check the expected changes; it would be more thorough to do so. The
intention is to only have minor wording changes apart from the `@implSpec` and
`@implNote` tags. Stylistically, I'd prefer the explicit `@foo {@inhertiDoc}`
idiom to indicate the code just want to use the javadoc from a supertype.
-------------
PR: https://git.openjdk.java.net/jdk/pull/8717
