On Wed, 7 Jun 2023 14:19:16 GMT, Pavel Rappo <[email protected]> wrote:
> Please review this long-awaited change to documentation inheritance.
>
> This change improves "methods comment algorithm" and introduces directed
> documentation inheritance. While "methods comment algorithm" -- automatic
> search for inheritable documentation -- has been improved, it still cannot
> read an author's mind so as to always find the documentation they intended.
> From now on, an author can state their intention, by providing an FQN of the
> superclass or superinterface from which to inherit documentation:
>
> {@inheritDoc S}
>
> Which is exactly what I did to counterbalance some of the JDK API
> Documentation changes caused by the change to "methods comment algorithm".
For details on changes to "methods comment algorithm", see the associated CSR:
https://bugs.openjdk.org/browse/JDK-8287152
-------------
PR Comment: https://git.openjdk.org/jdk/pull/14357#issuecomment-1581099793
