1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/*
* Copyright (c) 2021, 2022, 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 8262886
* @summary javadoc generates broken links with {@inheritDoc}
* @modules jdk.javadoc/jdk.javadoc.internal.api
* jdk.javadoc/jdk.javadoc.internal.tool
* jdk.compiler/com.sun.tools.javac.api
* jdk.compiler/com.sun.tools.javac.main
* @library ../../lib /tools/lib
* @build toolbox.ToolBox toolbox.ModuleBuilder javadoc.tester.*
* @run main TestRelativeModuleLinks
*/
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import javadoc.tester.JavadocTester;
import toolbox.ModuleBuilder;
import toolbox.ToolBox;
public class TestRelativeModuleLinks extends JavadocTester {
public final ToolBox tb;
public static void main(String... args) throws Exception {
var tester = new TestRelativeModuleLinks();
tester.runTests();
}
public TestRelativeModuleLinks() {
tb = new ToolBox();
}
@Test
public void testRelativeModuleLinks(Path base) throws IOException {
Path src = base.resolve("src");
new ModuleBuilder(tb, "ma")
.classes("package pa; public class A {}")
.exports("pa")
.comment("""
<a href="doc-files/file.html">relative module link</a>,
<a href="#module-fragment">fragment module link</a>.
<a id="module-fragment">Module fragment</a>.""")
.write(src);
new ModuleBuilder(tb, "mb")
.classes("package pb; public class B {}")
.exports("pb")
.requiresTransitive("ma")
.write(src);
Path docFiles = src.resolve("ma").resolve("doc-files");
tb.writeFile(docFiles.resolve("file.html"),
"""
<html>
<head><title>Module HTML File</title></head>
<body><h1>Module HTML File</h1>
File content</body>
</html>
""");
javadoc("-d", base.resolve("api").toString(),
"-quiet",
"--module-source-path", src.toString(),
"--module", "ma,mb");
checkExit(Exit.OK);
// Main page
checkOutput("index.html", true,
"""
<div class="block"><a href="./ma/doc-files/file.html">relative module link</a>,
<a href="./ma/module-summary.html#module-fragment">fragment module link</a>.</div>""");
// Index page
checkOutput("index-all.html", true,
"""
<div class="block"><a href="./ma/doc-files/file.html">relative module link</a>,
<a href="./ma/module-summary.html#module-fragment">fragment module link</a>.</div>""");
// Own module page
checkOutput("ma/module-summary.html", true,
"""
<div class="block"><a href="doc-files/file.html">relative module link</a>,
<a href="#module-fragment">fragment module link</a>.
<a id="module-fragment">Module fragment</a>.</div>""");
// Other module page
checkOutput("mb/module-summary.html", true,
"""
<div class="block"><a href="../ma/doc-files/file.html">relative module link</a>,
<a href="../ma/module-summary.html#module-fragment">fragment module link</a>.</div>""");
}
}
|
