[jdk19] RFR: 8287379: Using @inheritDoc in an inapplicable context shouldn't crash javadoc

Jonathan Gibbons jjg at openjdk.org
Mon Jun 27 17:56:45 UTC 2022


On Tue, 21 Jun 2022 16:12:44 GMT, Pavel Rappo <prappo at openjdk.org> wrote:

> This rights the wrongs of JDK-8008768. For more information, see the respective CSR.

It worries me that we are removing support for a feature that had explicit positive tests.

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclint/Checker.java line 268:

> 266:     // Checks if the passed tree path does NOT correspond to an entity, such as
> 267:     // the overview file and doc-files/**/*.html files.
> 268:     private boolean notPseudoElement(TreePath p) {

The use of a predicate named `not...` seems confusing and leads to various double negatives;  it would be easier to read if this was `isPseudoElement` even if that means an extra `!` at the call site.

test/langtools/jdk/javadoc/doclet/testRelativeLinks/TestRelativeLinks.java line 67:

> 65:                 <a href="#class-fragment">fragment class link</a>""",
> 66:             """
> 67:                 <a id="class-fragment">Class fragment</a>""",

Why are these lines (and similar, below) being deleted?

test/langtools/jdk/javadoc/doclet/testRelativeLinks/pkg/C.java line 32:

> 30:  *
> 31:  * <a id="class-fragment">Class fragment</a>.
> 32:  */

Why are these being deleted?

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

PR: https://git.openjdk.org/jdk19/pull/54


More information about the javadoc-dev mailing list