8284299: Handle inheritDoc misuse more gracefully

Reviewed-by: jjg

Author: Pavel Rappo

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/resources/doclets.properties

@@ -115,6 +115,7 @@ doclet.Version=Version:
 doclet.Factory=Factory:
 doclet.UnknownTag={0} is an unknown tag.
 doclet.UnknownTagLowercase={0} is an unknown tag -- same as a known tag except for case.
+doclet.inheritDocWithinInappropriateTag=@inheritDoc cannot be used within this tag
 doclet.noInheritedDoc=@inheritDoc used but {0} does not override or implement any method.
 doclet.tag_misuse=Tag {0} cannot be used in {1} documentation.  It can only be used in the following types of documentation: {2}.
 doclet.Package_Summary=Package Summary

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/taglets/InheritDocTaglet.java

@@ -82,7 +82,9 @@ private Content retrieveInheritedDocumentation(TagletWriter writer,
                         ? utils.flatSignature((ExecutableElement)e, writer.getCurrentPageElement())
                         : "");
                 //This tag does not support inheritance.
-                messages.warning(e, "doclet.noInheritedDoc", message);
+                var path = writer.configuration().utils.getCommentHelper(e).getDocTreePath(holderTag);
+                messages.warning(path, "doclet.inheritDocWithinInappropriateTag", message);
+                return replacement;
         }
         Input input = new DocFinder.Input(utils, e,
                 (InheritableTaglet) inheritableTaglet, new DocFinder.DocTreeInfo(holderTag, e),

test/langtools/jdk/javadoc/doclet/testInheritDocWithinInappropriateTag/TestInheritDocWithinInappropriateTag.java

@@ -0,0 +1,100 @@
+/*
+ * Copyright (c) 2022, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8284299
+ * @library /tools/lib ../../lib
+ * @modules jdk.javadoc/jdk.javadoc.internal.tool
+ * @build toolbox.ToolBox javadoc.tester.*
+ * @run main TestInheritDocWithinInappropriateTag
+ */
+
+import java.nio.file.Path;
+
+import javadoc.tester.JavadocTester;
+import toolbox.ToolBox;
+
+public class TestInheritDocWithinInappropriateTag extends JavadocTester {
+
+    public static void main(String... args) throws Exception {
+        new TestInheritDocWithinInappropriateTag()
+                .runTests(m -> new Object[]{Path.of(m.getName())});
+    }
+
+    private final ToolBox tb = new ToolBox();
+
+    @Test
+    public void test(Path base) throws Exception {
+        Path src = base.resolve("src");
+        tb.writeJavaFiles(src,
+                """
+                        public class A {
+                            /**
+                             * A.x().
+                             */
+                            public void x() { }
+                        }
+                        """,
+                """
+                        public class B extends A {
+                            /**
+                             * {@summary {@inheritDoc}}
+                             *
+                             * {@link Object#hashCode() {@inheritDoc}}
+                             * {@linkplain Object#hashCode() {@inheritDoc}}
+                             *
+                             * {@index term {@inheritDoc}}
+                             */
+                            @Override
+                            public void x() { }
+                        }
+                        """);
+        javadoc("-Xdoclint:none",
+                "-d", base.resolve("out").toString(),
+                src.resolve("A.java").toString(),
+                src.resolve("B.java").toString());
+        checkExit(Exit.OK);
+        new OutputChecker(Output.OUT).setExpectOrdered(false).check(
+                """
+                        warning: @inheritDoc cannot be used within this tag
+                             * {@summary {@inheritDoc}}
+                               ^
+                        """,
+                """
+                        warning: @inheritDoc cannot be used within this tag
+                             * {@link Object#hashCode() {@inheritDoc}}
+                               ^
+                        """,
+                """
+                        warning: @inheritDoc cannot be used within this tag
+                             * {@linkplain Object#hashCode() {@inheritDoc}}
+                               ^
+                        """,
+                """
+                        warning: @inheritDoc cannot be used within this tag
+                             * {@index term {@inheritDoc}}
+                               ^
+                        """);
+    }
+}