RFR: 8285368: Overhaul doc-comment inheritance [v5]

Pavel Rappo prappo at openjdk.org
Thu Jun 8 09:26:16 UTC 2023


> 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".

Pavel Rappo has updated the pull request incrementally with one additional commit since the last revision:

  feedback: DocLint terminology

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/14357/files
  - new: https://git.openjdk.org/jdk/pull/14357/files/d579a83c..93adde63

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=14357&range=04
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=14357&range=03-04

  Stats: 2 lines in 1 file changed: 0 ins; 0 del; 2 mod
  Patch: https://git.openjdk.org/jdk/pull/14357.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/14357/head:pull/14357

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


More information about the core-libs-dev mailing list