> 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 14 additional commits since the
last revision:
- 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
- Merge branch 'master' into 8285368
- feedback: make warning less scary
- Disable problematic check
This check is well-intended but problematic for JDK API Documentation
build, which errors on warnings.
- ... and 4 more: https://git.openjdk.org/jdk/compare/e7a50303...563a8761
-------------
Changes:
- all: https://git.openjdk.org/jdk/pull/14357/files
- new: https://git.openjdk.org/jdk/pull/14357/files/cccffa66..563a8761
Webrevs:
- full: https://webrevs.openjdk.org/?repo=jdk&pr=14357&range=08
- incr: https://webrevs.openjdk.org/?repo=jdk&pr=14357&range=07-08
Stats: 11904 lines in 355 files changed: 9502 ins; 1007 del; 1395 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
