On Thu, 29 Jul 2021 16:18:24 GMT, Kevin Rushforth <[email protected]> wrote:
> As noted in the JBS bug report, the javadoc-generated HTML table for a class
> is messed up if any method is overridden from a core JDK class and has the
> `{@inheritDoc}` tag. For example, the following taken from the
> [Background](https://github.com/openjdk/jfx/blob/jfx17/modules/javafx.graphics/src/main/java/javafx/scene/layout/Background.java#L622)
> class provokes this bug:
>
>
> /**
> * {@inheritDoc}
> */
> @Override public boolean equals(Object o) {
>
>
> The proposed fix is to stop generating javadocs for overridden methods with
> no spec change. This matches how the JDK docs have been generated since JDK
> 10. See [JDK-8157000](https://bugs.openjdk.java.net/browse/JDK-8157000). This
> is done by running `javadoc` with the `--override-methods=summary` option.
>
> There is no useful information generated for such overridden methods
> regardless of whether or not they use the `{@inheritDoc}` tag, so this fix
> also addresses the problem of having methods with no description.
>
> See the attached "before" and "after" images.
>
> Before:
>
> 
>
> After:
>
> 
This pull request has now been integrated.
Changeset: fbeb0bbd
Author: Kevin Rushforth <[email protected]>
URL:
https://git.openjdk.java.net/jfx/commit/fbeb0bbd1cec6616b01e8376013f833a191124e8
Stats: 4 lines in 1 file changed: 4 ins; 0 del; 0 mod
8271485: Javadoc "Method Summary" table is misaligned if overridden JDK method
has {@inheritDoc} tag
Do not generate javadocs for overridden methods with no spec change
Reviewed-by: aghaisas, arapte
-------------
PR: https://git.openjdk.java.net/jfx/pull/593
