> 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 with a new target base due to a merge 
or a rebase. The incremental webrev excludes the unrelated changes brought in 
by the merge/rebase. The pull request contains 17 additional commits since the 
last revision:

 - Merge branch 'master' into 8285368
 - Update @since tags
 - Add a test
 - fix failing SourceDocTreeScannerTest
 - Merge branch 'master' into 8285368
 - feedback: use JavadocTester.out
   
   Also, trivially fixes grammar (word order) in a comment.
 - feedback: remove unduly restrictive warning
 - suggestion: vocabulary
 - feedback: DocLint terminology
 - feedback: use utils directly
 - ... and 7 more: https://git.openjdk.org/jdk/compare/5a217d2b...5b6af244

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/14357/files
  - new: https://git.openjdk.org/jdk/pull/14357/files/563a8761..5b6af244

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

  Stats: 8391 lines in 228 files changed: 1225 ins; 6803 del; 363 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

Reply via email to