Withdrawn: 8223607: --override-methods=summary ignores some signature changes

Hannes Wallnöfer hannesw at openjdk.java.net
Fri Dec 18 14:32:26 UTC 2020


On Thu, 10 Dec 2020 13:17:49 GMT, Hannes Wallnöfer <hannesw at openjdk.org> wrote:

> This change causes overriding methods to be documented in the details section under some conditions even when javadoc is run with `--override-methods=summary` and the method does not have a doc comment. Previously this already happened when the overriding method had a covariant return type (JDK-8219147). The following conditions will now trigger the same behaviour:
> 
>  - method visibility changes from `protected` to `public`
>  - any change in thrown exceptions
>  - change in documented annotations anywhere in the method signature
> 
> The conditions are simple by intention as we don't want to do checks that add to much complexity (such as distinguishing between checked and unchecked exceptions) and instead want to set the bar for inclusion in the details section relatively low.

This pull request has been closed without being integrated.

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

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


More information about the javadoc-dev mailing list