changeset 46082:c65be9fae87b

8185151: doclet may create a link to a missing anchor/id Reviewed-by: jjg, ksrini
author pmuthuswamy
date Wed, 02 Aug 2017 15:09:24 -0700
parents 7c6d73d10b6b
children cb32a3e7a863
files langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleWriterImpl.java langtools/test/jdk/javadoc/doclet/testModules/TestModuleServicesLink.java
diffstat 2 files changed, 122 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleWriterImpl.java	Wed Aug 02 12:34:23 2017 -0700
+++ b/langtools/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/ModuleWriterImpl.java	Wed Aug 02 15:09:24 2017 -0700
@@ -1007,8 +1007,7 @@
                 ? getHyperLink(SectionName.PACKAGES, contents.navPackages)
                 : contents.navPackages);
         addNavGap(liNav);
-        liNav.addContent((display(uses) || (moduleMode == ModuleMode.API && display(usesTrees))
-                || display(provides) || (moduleMode == ModuleMode.API && display(providesTrees)))
+        liNav.addContent((displayServices(uses, usesTrees) || displayServices(provides.keySet(), providesTrees))
                 ? getHyperLink(SectionName.SERVICES, contents.navServices)
                 : contents.navServices);
         ulNav.addContent(liNav);
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/test/jdk/javadoc/doclet/testModules/TestModuleServicesLink.java	Wed Aug 02 15:09:24 2017 -0700
@@ -0,0 +1,121 @@
+/*
+ * Copyright (c) 2017, 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 8185151
+ * @summary test that navigation summary links are not linked when there are no dependencies
+ * @modules jdk.javadoc/jdk.javadoc.internal.api
+ *          jdk.javadoc/jdk.javadoc.internal.tool
+ * @library ../lib /tools/lib
+ * @build toolbox.ToolBox toolbox.ModuleBuilder JavadocTester
+ * @run main TestModuleServicesLink
+ */
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import toolbox.*;
+
+public class TestModuleServicesLink extends JavadocTester {
+
+    public final ToolBox tb;
+    public static void main(String... args) throws Exception {
+        TestModuleServicesLink  tester = new TestModuleServicesLink ();
+        tester.runTests(m -> new Object[] { Paths.get(m.getName()) });
+    }
+
+    public TestModuleServicesLink () {
+        tb = new ToolBox();
+    }
+
+    @Test
+    public void checkNavbarWithServices1(Path base) throws Exception {
+        ModuleBuilder mb = new ModuleBuilder(tb, "m")
+                .comment("module m.\n@uses p1.A")
+                .uses("p1.A")
+                .uses("p1.B")
+                .exports("p1")
+                .classes("package p1; public class A {}")
+                .classes("package p1; public class B {}");
+        mb.write(base);
+
+        javadoc("-d", base.toString() + "/out",
+                "-quiet",
+                "--module-source-path", base.toString(),
+                "--module", "m");
+        checkExit(Exit.OK);
+
+        checkOutput("m-summary.html", true,
+                "<a href=\"#module.description\">Description</a>&nbsp;|"
+                + "&nbsp;Modules&nbsp;|"
+                + "&nbsp;<a href=\"#packages.summary\">Packages</a>&nbsp;|"
+                + "&nbsp;<a href=\"#services.summary\">Services</a>");
+
+    }
+
+    @Test
+    public void checkNavbarWithServices2(Path base) throws Exception {
+        ModuleBuilder mb = new ModuleBuilder(tb, "m")
+                        .comment("module m.\n@provides p1.A")
+                        .provides("p1.A", "p1.B")
+                        .exports("p1")
+                        .classes("package p1; public interface A {}")
+                        .classes("package p1; public class B implements A {}");
+        mb.write(base);
+
+        javadoc("-d", base.toString() + "/out",
+                "-quiet",
+                "--module-source-path", base.toString(),
+                "--module", "m");
+        checkExit(Exit.OK);
+
+        checkOutput("m-summary.html", true,
+                "<a href=\"#module.description\">Description</a>&nbsp;|"
+                + "&nbsp;Modules&nbsp;|"
+                + "&nbsp;<a href=\"#packages.summary\">Packages</a>&nbsp;|"
+                + "&nbsp;<a href=\"#services.summary\">Services</a>");
+
+    }
+
+    @Test
+    public void checkNavbarWithoutServices(Path base) throws Exception {
+        ModuleBuilder mb = new ModuleBuilder(tb, "m")
+                .exports("p1")
+                .classes("package p1; public class A {}")
+                .classes("package p1; public class B {}");
+        mb.write(base);
+
+        javadoc("-d", base.toString() + "/out",
+                "-quiet",
+                "--module-source-path", base.toString(),
+                "--module", "m");
+        checkExit(Exit.OK);
+
+        checkOutput("m-summary.html", true,
+                "Description&nbsp;|&nbsp;Modules&nbsp;|"
+                + "&nbsp;<a href=\"#packages.summary\">Packages</a>&nbsp;|"
+                + "&nbsp;Services");
+    }
+
+}