8202627: javadoc generates broken links to deprecated items when -nodeprecated is used
Reviewed-by: ksrini
--- a/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassUseMapper.java Sun Jun 03 09:19:48 2018 +0200
+++ b/src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/toolkit/util/ClassUseMapper.java Sun Jun 03 19:21:18 2018 +0530
@@ -215,7 +215,9 @@
mapAnnotations(classToPackageAnnotations, pkg, pkg);
mapTypeParameters(classToClassTypeParam, aClass, aClass);
mapAnnotations(classToClassAnnotations, aClass, aClass);
- List<VariableElement> fields = utils.getFields(aClass);
+ VisibleMemberTable vmt = configuration.getVisibleMemberTable(aClass);
+
+ List<VariableElement> fields = ElementFilter.fieldsIn(vmt.getVisibleMembers(FIELDS));
for (VariableElement fd : fields) {
mapTypeParameters(classToFieldTypeParam, fd, fd);
mapAnnotations(annotationToField, fd, fd);
@@ -238,13 +240,12 @@
stv.visit(fd.asType(), fd);
}
- List<ExecutableElement> ctors = utils.getConstructors(aClass);
+ List<ExecutableElement> ctors = ElementFilter.constructorsIn(vmt.getMembers(CONSTRUCTORS));
for (ExecutableElement ctor : ctors) {
mapAnnotations(classToConstructorAnnotations, ctor, ctor);
mapExecutable(ctor);
}
- VisibleMemberTable vmt = configuration.getVisibleMemberTable(aClass);
List<ExecutableElement> methods = ElementFilter.methodsIn(vmt.getMembers(METHODS));
for (ExecutableElement method : methods) {
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/test/langtools/jdk/javadoc/doclet/testLinksWithNoDeprecatedOption/TestLinksWithNoDeprecatedOption.java Sun Jun 03 19:21:18 2018 +0530
@@ -0,0 +1,117 @@
+/*
+ * 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 8202627
+ * @summary javadoc generates broken links to deprecated items when -nodeprecated is used
+ * @library /tools/lib ../lib
+ * @modules
+ * jdk.javadoc/jdk.javadoc.internal.tool
+ * jdk.compiler/com.sun.tools.javac.api
+ * jdk.compiler/com.sun.tools.javac.main
+ * @build JavadocTester
+ * @run main TestLinksWithNoDeprecatedOption
+ */
+
+
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import builder.ClassBuilder;
+import builder.ClassBuilder.FieldBuilder;
+import builder.ClassBuilder.MethodBuilder;
+import toolbox.ToolBox;
+
+public class TestLinksWithNoDeprecatedOption extends JavadocTester {
+
+ final ToolBox tb;
+
+ public static void main(String... args) throws Exception {
+ TestLinksWithNoDeprecatedOption tester = new TestLinksWithNoDeprecatedOption();
+ tester.runTests(m -> new Object[]{Paths.get(m.getName())});
+ }
+
+ TestLinksWithNoDeprecatedOption() {
+ tb = new ToolBox();
+ }
+
+ @Test
+ void test(Path base) throws Exception {
+ Path srcDir = base.resolve("src");
+ createTestClass(base, srcDir);
+
+ Path outDir = base.resolve("out");
+ javadoc("-d", outDir.toString(),
+ "-nodeprecated",
+ "-use",
+ "-sourcepath", srcDir.toString(),
+ "pkg");
+
+ checkExit(Exit.OK);
+
+ checkOutput("pkg/class-use/A.html", true,
+ "<span class=\"memberNameLink\">"
+ + "<a href=\"../B.html#a2\">a2</a></span>");
+
+ //links for deprecated items will not be found
+ checkOutput("pkg/class-use/A.html", false,
+ "<span class=\"memberNameLink\">"
+ + "<a href=\"../B.html#deprecatedField\">deprecatedField</a></span>");
+
+ checkOutput("pkg/class-use/A.html", false,
+ "<span class=\"memberNameLink\">"
+ + "<a href=\"../B.html#deprecatedMethod(pkg.A)\">deprecatedMethod</a></span>");
+
+ checkOutput("pkg/class-use/A.html",false,
+ "<span class=\"memberNameLink\">"
+ + "<a href=\"../B.html#%3Cinit%3E(pkg.A)\">B</a></span>");
+
+ }
+
+ void createTestClass(Path base, Path srcDir) throws Exception {
+ new ClassBuilder(tb, "pkg.A")
+ .setModifiers("public", "class")
+ .write(srcDir);
+
+ MethodBuilder method = MethodBuilder
+ .parse("public void deprecatedMethod(A a) {}")
+ .setComments(
+ "@deprecated",
+ "@param A a param");
+
+ MethodBuilder constructor = MethodBuilder
+ .parse("public B(A a) {}")
+ .setComments("@deprecated");
+
+
+ new ClassBuilder(tb, "pkg.B")
+ .setModifiers("public", "class")
+ .addMembers(
+ constructor,
+ method,
+ FieldBuilder.parse("public A deprecatedField").setComments("@deprecated"),
+ FieldBuilder.parse("public A a2"))
+ .write(srcDir);
+ }
+}
--- a/test/langtools/jdk/javadoc/doclet/testSearch/TestSearch.java Sun Jun 03 09:19:48 2018 +0200
+++ b/test/langtools/jdk/javadoc/doclet/testSearch/TestSearch.java Sun Jun 03 19:21:18 2018 +0530
@@ -241,7 +241,6 @@
@Test
void test7() {
- setAutomaticCheckLinks(false); // @ignore JDK-8202627
javadoc("-d", "out-7",
"-nodeprecated",
"-Xdoclint:none",
@@ -249,7 +248,7 @@
"-use",
"--frames",
"pkg", "pkg1", "pkg2", "pkg3");
- setAutomaticCheckLinks(true); // @ignore JDK-8202627
+
checkExit(Exit.OK);
checkSearchOutput(true);
checkIndexNoDeprecated();