infernap12/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2026-03-14 18:03:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

8236539: Relative link tags in record javadoc don't resolve

Browse Source 
Reviewed-by: hannesw
This commit is contained in:
Jonathan Gibbons 2020-06-16 14:42:06 -07:00
parent dee90e4736
commit a27ee6b284
2 changed files with 100 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/AbstractIndexWriter.java
View File

@ -159,6 +159,7 @@ public class AbstractIndexWriter extends HtmlDocletWriter {
break;
case CLASS:
case ENUM:
case RECORD:
case ANNOTATION_TYPE:
case INTERFACE:
dt = HtmlTree.DT(getLink(new LinkInfoImpl(configuration,

99
test/langtools/jdk/javadoc/doclet/testRecordLinks/TestRecordLinks.java Normal file
View File

@ -0,0 +1,99 @@
/*
* Copyright (c) 2020, 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 8236539
* @summary Relative link tags in record javadoc don't resolve
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @compile --enable-preview --source ${jdk.version} TestRecordLinks.java
* @run main/othervm --enable-preview TestRecordLinks
*/
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestRecordLinks extends JavadocTester {
public static void main(String... args) throws Exception {
TestRecordLinks tester = new TestRecordLinks();
tester.runTests(m -> new Object[] { Path.of(m.getName()) });
}
private final ToolBox tb = new ToolBox();
@Test
public void testCrash(Path base) throws Exception {
// from JDK-8236539
String example = """
package example;
public class JavadocTest {
/**
* {@link #foo()}
* {@link Bar}
*/
public static class Foo {
public void foo() { }
}
/**
* {@link #bar()}
* {@link Foo}
*/
public record Bar() {
public void bar() { }
}
}
""";
Path src = base.resolve("src");
tb.writeJavaFiles(src, example);
javadoc("-d", base.resolve("out").toString(),
"-sourcepath", src.toString(),
"--enable-preview", "--source", thisRelease,
"example");
checkExit(Exit.OK);
checkOutput("example/JavadocTest.Foo.html", true,
"""
<h1 title="Class JavadocTest.Foo" class="title">Class JavadocTest.Foo</h1>
""",
"""
<div class="block"><a href="#foo()"><code>foo()</code></a>
<a href="JavadocTest.Bar.html" title="class in example"><code>JavadocTest.Bar</code></a></div>
""");
checkOutput("example/JavadocTest.Bar.html", true,
"""
<h1 title="Record JavadocTest.Bar" class="title">Record JavadocTest.Bar</h1>
""",
"""
<div class="block"><a href="#bar()"><code>bar()</code></a>
<a href="JavadocTest.Foo.html" title="class in example"><code>JavadocTest.Foo</code></a></div>
""");
}
}