8269722: NPE in HtmlDocletWriter

Reviewed-by: hannesw

Author: jonathan-gibbons

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDocletWriter.java

@@ -75,6 +75,7 @@
 import com.sun.source.doctree.SummaryTree;
 import com.sun.source.doctree.SystemPropertyTree;
 import com.sun.source.doctree.TextTree;
+import com.sun.source.util.DocTreePath;
 import com.sun.source.util.SimpleDocTreeVisitor;
 
 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
@@ -1515,9 +1516,16 @@ public Boolean visitEntity(EntityTree node, Content c) {
 
                 @Override
                 public Boolean visitErroneous(ErroneousTree node, Content c) {
-                    messages.warning(ch.getDocTreePath(node),
-                            "doclet.tag.invalid_usage", node);
-                    result.add(new RawHtml(node.toString()));
+                    DocTreePath dtp = ch.getDocTreePath(node);
+                    if (dtp != null) {
+                        String body = node.getBody();
+                        if (body.matches("(?i)\\{@[a-z]+.*")) {
+                            messages.warning(dtp,"doclet.tag.invalid_usage", body);
+                        } else {
+                            messages.warning(dtp, "doclet.tag.invalid_input", body);
+                        }
+                    }
+                    result.add(Text.of(node.toString()));
                     return false;
                 }
 
@@ -1542,7 +1550,10 @@ public Boolean visitIndex(IndexTree node, Content p) {
                 public Boolean visitLink(LinkTree node, Content c) {
                     var inTags = context.inTags;
                     if (inTags.contains(LINK) || inTags.contains(LINK_PLAIN) || inTags.contains(SEE)) {
-                        messages.warning(ch.getDocTreePath(node), "doclet.see.nested_link", "{@" + node.getTagName() + "}");
+                        DocTreePath dtp = ch.getDocTreePath(node);
+                        if (dtp != null) {
+                            messages.warning(dtp, "doclet.see.nested_link", "{@" + node.getTagName() + "}");
+                        }
                         Content label = commentTagsToContent(node, element, node.getLabel(), context);
                         if (label.isEmpty()) {
                             label = Text.of(node.getReference().getSignature());

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties

@@ -104,6 +104,7 @@ doclet.see.class_or_package_not_found=Tag {0}: reference not found: {1}
 doclet.see.class_or_package_not_accessible=Tag {0}: reference not accessible: {1}
 doclet.see.nested_link=Tag {0}: nested link
 doclet.tag.invalid_usage=invalid usage of tag {0}
+doclet.tag.invalid_input=invalid input: ''{0}''
 doclet.Deprecated_API=Deprecated API
 doclet.Deprecated_Elements=Deprecated {0}
 doclet.Deprecated_In_Release=Deprecated in {0}

test/langtools/jdk/javadoc/doclet/testInherited/TestInherited.java

@@ -0,0 +1,95 @@
+/*
+ * Copyright (c) 2021, 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 8269722
+ * @summary NPE in HtmlDocletWriter, reporting errors on inherited tags
+ * @library /tools/lib ../../lib
+ * @modules jdk.javadoc/jdk.javadoc.internal.tool
+ * @build toolbox.ToolBox javadoc.tester.*
+ * @run main TestInherited
+ */
+
+import java.nio.file.Path;
+
+import javadoc.tester.JavadocTester;
+import toolbox.ToolBox;
+
+public class TestInherited extends JavadocTester {
+
+    public static void main(String... args) throws Exception {
+        TestInherited tester = new TestInherited();
+        tester.runTests(m -> new Object[] { Path.of(m.getName())});
+    }
+
+    private final ToolBox tb = new ToolBox();
+
+    @Test
+    public void testBadInheritedParam(Path base) throws Exception {
+        Path src = base.resolve("src");
+        tb.writeJavaFiles(src, """
+                public class BadParam {
+                    public static class Base {
+                        /**
+                         * @param i a < b
+                         */
+                        public void m(int i) { }
+                    }
+
+                    public static class Sub extends Base {
+                        public void m(int i) { }
+                    }
+                }
+                """);
+
+        javadoc("-d", base.resolve("out").toString(),
+                "-Xdoclint:-missing", "-XDdoe",
+                src.resolve("BadParam.java").toString());
+        checkExit(Exit.OK);
+    }
+
+    @Test
+    public void testBadInheritedReturn(Path base) throws Exception {
+        Path src = base.resolve("src");
+        tb.writeJavaFiles(src, """
+                public class BadReturn {
+                    public static class Base {
+                        /**
+                         * @return  a < b
+                         */
+                        public int m() { }
+                    }
+
+                    public static class Sub extends Base {
+                        public int m() { }
+                    }
+                }
+                """);
+
+        javadoc("-d", base.resolve("out").toString(),
+                "-Xdoclint:-missing",
+                src.resolve("BadReturn.java").toString());
+        checkExit(Exit.OK);
+    }
+}

test/langtools/jdk/javadoc/doclet/testJavaFX/TestJavaFX.java

@@ -374,7 +374,7 @@ public void test4() {
         checkExit(Exit.OK);
 
         // make sure the doclet indeed emits the warning
-        checkOutput(Output.OUT, true, "C.java:31: warning: invalid usage of tag <");
+        checkOutput(Output.OUT, true, "C.java:31: warning: invalid input: '<'");
     }
 
     /*

test/langtools/jdk/javadoc/doclet/testNonInlineHtmlTagRemoval/TestNonInlineHtmlTagRemoval.java

@@ -85,6 +85,6 @@ public void testNegative() {
 
         checkOutput("Negative.html", true,
                 """
-                    <div class="block">case1: A hanging &lt;  : xx<</div>""");
+                    <div class="block">case1: A hanging &lt;  : xx&lt;</div>""");
     }
 }