stan/jdk-24
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

8202624: javadoc generates references to enum constructors, which are not documented

Browse Source 
Reviewed-by: sundar
This commit is contained in:
Priya Lakshmi Muthuswamy 2018-06-20 14:52:32 +05:30
parent ecbeb2db13
commit aefa5d6fbe
4 changed files with 105 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/IndexBuilder.java
View File

@ -164,12 +164,12 @@ public class IndexBuilder {
* @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));
}

1
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/VisibleMemberTable.java
View File

@ -676,7 +676,6 @@ public class VisibleMemberTable {
addMember(e, Kind.METHODS);
break;
case CONSTRUCTOR:
if (!utils.isEnum(te))
addMember(e, Kind.CONSTRUCTORS);
break;
case ENUM_CONSTANT:

100
test/langtools/jdk/javadoc/doclet/testEnumConstructor/TestEnumConstructor.java Normal file
View File

@ -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"
+ "}");
}
}

7
test/langtools/jdk/javadoc/doclet/testHtmlVersion/TestHtmlVersion.java
View File

@ -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 @@ public class TestHtmlVersion extends JavadocTester {
@Test
void test1() {
setAutomaticCheckLinks(false); // @ignore JDK-8202624
javadoc("-d", "out-1",
"-private",
"-linksource",
@ -49,7 +49,6 @@ public class TestHtmlVersion extends JavadocTester {
"-sourcepath", testSrc,
"-use",
"pkg", "pkg1", "pkg2", "pkg3");
setAutomaticCheckLinks(true); // @ignore JDK-8202624
checkExit(Exit.OK);
html5Output();
@ -58,7 +57,6 @@ public class TestHtmlVersion extends JavadocTester {
@Test
void test2() {
setAutomaticCheckLinks(false); // @ignore JDK-8202624
javadoc("-d", "out-2",
"-html4",
"-private",
@ -67,7 +65,6 @@ public class TestHtmlVersion extends JavadocTester {
"-sourcepath", testSrc,
"-use",
"pkg", "pkg1", "pkg2", "pkg3");
setAutomaticCheckLinks(true); // @ignore JDK-8202624
checkExit(Exit.OK);
html4Output();
@ -76,7 +73,6 @@ public class TestHtmlVersion extends JavadocTester {
@Test
void test3() {
setAutomaticCheckLinks(false); // @ignore JDK-8202624
javadoc("-d", "out-3",
"-html4",
"-private",
@ -85,7 +81,6 @@ public class TestHtmlVersion extends JavadocTester {
"-sourcepath", testSrc,
"-use",
"pkg", "pkg1", "pkg2", "pkg3");
setAutomaticCheckLinks(true); // @ignore JDK-8202624
checkExit(Exit.OK);
html4Output();