changeset 51306:35a87577b461

8202624: javadoc generates references to enum constructors, which are not documented Reviewed-by: sundar
author pmuthuswamy
date Wed, 20 Jun 2018 14:52:32 +0530
parents 1637a4e50fc9
children e7da80712449
files src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/IndexBuilder.java src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java test/langtools/jdk/javadoc/doclet/testEnumConstructor/TestEnumConstructor.java test/langtools/jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java
diffstat 4 files changed, 105 insertions(+), 11 deletions(-) [+]
line wrap: on
line diff
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/IndexBuilder.java	Wed Jun 20 11:12:58 2018 +0200
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/IndexBuilder.java	Wed Jun 20 14:52:32 2018 +0530
@@ -164,12 +164,12 @@
      * @param te TypeElement whose members will be added to the indexmap.
      */
     protected void putMembersInIndexMap(TypeElement te) {
-        adjustIndexMap(utils.getAnnotationFields(te));
-        adjustIndexMap(utils.getFields(te));
         VisibleMemberTable vmt = configuration.getVisibleMemberTable(te);
+        adjustIndexMap(vmt.getMembers(ANNOTATION_TYPE_FIELDS));
+        adjustIndexMap(vmt.getMembers(FIELDS));
         adjustIndexMap(vmt.getMembers(METHODS));
-        adjustIndexMap(utils.getConstructors(te));
-        adjustIndexMap(utils.getEnumConstants(te));
+        adjustIndexMap(vmt.getMembers(CONSTRUCTORS));
+        adjustIndexMap(vmt.getMembers(ENUM_CONSTANTS));
     }
 
 
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java	Wed Jun 20 11:12:58 2018 +0200
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java	Wed Jun 20 14:52:32 2018 +0530
@@ -676,7 +676,6 @@
                         addMember(e, Kind.METHODS);
                         break;
                     case CONSTRUCTOR:
-                        if (!utils.isEnum(te))
                             addMember(e, Kind.CONSTRUCTORS);
                         break;
                     case ENUM_CONSTANT:
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/langtools/jdk/javadoc/doclet/testEnumConstructor/TestEnumConstructor.java	Wed Jun 20 14:52:32 2018 +0530
@@ -0,0 +1,100 @@
+/*
+ * Copyright (c) 2018, 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 8202624
+ * @summary javadoc generates references to enum constructors, which are not documented
+ * @library /tools/lib ../lib
+ * @modules jdk.javadoc/jdk.javadoc.internal.tool
+ * @build JavadocTester
+ * @run main TestEnumConstructor
+ */
+
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import toolbox.ToolBox;
+
+public class TestEnumConstructor extends JavadocTester {
+
+    final ToolBox tb;
+
+    public static void main(String... args) throws Exception {
+        TestEnumConstructor tester = new TestEnumConstructor();
+        tester.runTests(m -> new Object[]{Paths.get(m.getName())});
+    }
+
+    TestEnumConstructor() {
+        tb = new ToolBox();
+    }
+
+    @Test
+    void test1(Path base) throws Exception {
+        Path srcDir = base.resolve("src");
+        createEnum(srcDir);
+
+        Path outDir = base.resolve("out");
+        javadoc("-d", outDir.toString(),
+                "-private",
+                "-sourcepath", srcDir.toString(),
+                "pkg");
+
+        checkExit(Exit.OK);
+        checkOrder("pkg/TestEnum.html",
+                "Constructor Summary",
+                "Modifier", "Constructor",
+                "private", "<a href=\"#%3Cinit%3E(int)\">TestEnum</a></span>&#8203;(int&nbsp;val)");
+        checkOutput("index-all.html", true,
+                "<a href=\"pkg/TestEnum.html#%3Cinit%3E(int)\">TestEnum(int)</a>");
+
+    }
+
+    @Test
+    void test2(Path base) throws Exception {
+        Path srcDir = base.resolve("src");
+        createEnum(srcDir);
+
+        Path outDir = base.resolve("out");
+        javadoc("-d", outDir.toString(),
+                "-package",
+                "-sourcepath", srcDir.toString(),
+                "pkg");
+
+        checkExit(Exit.OK);
+        checkOutput("pkg/TestEnum.html", false, "Constructor Summary");
+        checkOutput("index-all.html", false,
+                "<a href=\"pkg/TestEnum.html#%3Cinit%3E(int)\">TestEnum(int)</a>");
+    }
+
+    void createEnum(Path srcDir) throws Exception {
+        tb.writeJavaFiles(srcDir,
+                "package pkg;\n"
+                + "public enum TestEnum{\n"
+                + "CONST1(100),CONST2(50),CONST3(10);\n"
+                + "private int val;\n"
+                + "TestEnum(int val){this.val=val;}\n"
+                + "}");
+    }
+}
--- a/test/langtools/jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java	Wed Jun 20 11:12:58 2018 +0200
+++ b/test/langtools/jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java	Wed Jun 20 14:52:32 2018 +0530
@@ -24,6 +24,7 @@
 /*
  * @test
  * @bug 8072945 8081854 8141492 8148985 8150188 4649116 8173707 8151743 8169819 8183037 8182765 8196202
+ *      8202624
  * @summary Test the version of HTML generated by the javadoc tool.
  * @author bpatel
  * @library ../lib
@@ -41,7 +42,6 @@
 
     @Test
     void test1() {
-        setAutomaticCheckLinks(false); // @ignore JDK-8202624
         javadoc("-d", "out-1",
                 "-private",
                 "-linksource",
@@ -49,7 +49,6 @@
                 "-sourcepath", testSrc,
                 "-use",
                 "pkg", "pkg1", "pkg2", "pkg3");
-        setAutomaticCheckLinks(true); // @ignore JDK-8202624
         checkExit(Exit.OK);
 
         html5Output();
@@ -58,7 +57,6 @@
 
     @Test
     void test2() {
-        setAutomaticCheckLinks(false); // @ignore JDK-8202624
         javadoc("-d", "out-2",
                 "-html4",
                 "-private",
@@ -67,7 +65,6 @@
                 "-sourcepath", testSrc,
                 "-use",
                 "pkg", "pkg1", "pkg2", "pkg3");
-        setAutomaticCheckLinks(true); // @ignore JDK-8202624
         checkExit(Exit.OK);
 
         html4Output();
@@ -76,7 +73,6 @@
 
     @Test
     void test3() {
-        setAutomaticCheckLinks(false); // @ignore JDK-8202624
         javadoc("-d", "out-3",
                 "-html4",
                 "-private",
@@ -85,7 +81,6 @@
                 "-sourcepath", testSrc,
                 "-use",
                 "pkg", "pkg1", "pkg2", "pkg3");
-        setAutomaticCheckLinks(true); // @ignore JDK-8202624
         checkExit(Exit.OK);
 
         html4Output();