Integrated: 8285368: Overhaul doc-comment inheritance

Pavel Rappo prappo at openjdk.org
Thu Jun 15 17:58:25 UTC 2023


On Wed, 7 Jun 2023 14:19:16 GMT, Pavel Rappo <prappo at openjdk.org> 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".

This pull request has now been integrated.

Changeset: 3e0bbd29
Author:    Pavel Rappo <prappo at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/3e0bbd290c534b0f9729c54cd45308d505907797
Stats:     1768 lines in 32 files changed: 1634 ins; 32 del; 102 mod

8285368: Overhaul doc-comment inheritance
6376959: Algorithm for Inheriting Method Comments seems to go not as documented
6934301: Support directed inheriting of class comments with @inheritDoc

Reviewed-by: jjg, rriggs, aivanov, smarks, martin

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

PR: https://git.openjdk.org/jdk/pull/14357


More information about the core-libs-dev mailing list