Integrated: 8285470: Improve handling of @inheritDoc
Pavel Rappo
prappo at openjdk.java.net
Wed May 4 20:58:27 UTC 2022
On Fri, 22 Apr 2022 14:05:44 GMT, Pavel Rappo <prappo at openjdk.org> wrote:
> The only taglet that along with its own tag needs to know the immediately enclosing tag is `InheritDocTaglet`:
>
> @return {@inheritDoc}
> @throws NullPointerException {@inheritDoc}
> @param p {@inheritDoc}
>
> However, the immediately enclosing tag is unconditionally passed to all taglets. If we stop passing it and make `InheritDocTaglet` compute it instead, the code becomes cleaner.
>
> While reviewing, particularly note these benefits of the proposed change:
>
> * taglet-handling code knows less about `@inheritDoc`, and
> * `InheritDocTaglet` receives its own tag, not the tag that encloses it
This pull request has now been integrated.
Changeset: bb022b24
Author: Pavel Rappo <prappo at openjdk.org>
URL: https://git.openjdk.java.net/jdk/commit/bb022b24cfdad9d6826140c6b26c46f480e7457d
Stats: 74 lines in 7 files changed: 5 ins; 26 del; 43 mod
8285470: Improve handling of @inheritDoc
Reviewed-by: jjg
-------------
PR: https://git.openjdk.java.net/jdk/pull/8361
More information about the javadoc-dev
mailing list