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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* 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 8205593
* @summary Javadoc -link makes broken links if module name matches package name
* @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 TestLinkOptionWithModule
*/
import java.nio.file.Path;
import java.nio.file.Paths;
import builder.ClassBuilder;
import builder.ClassBuilder.*;
import toolbox.ModuleBuilder;
import toolbox.ToolBox;
public class TestLinkOptionWithModule extends JavadocTester {
final ToolBox tb;
private final Path src;
public static void main(String... args) throws Exception {
TestLinkOptionWithModule tester = new TestLinkOptionWithModule();
tester.runTests(m -> new Object[]{Paths.get(m.getName())});
}
TestLinkOptionWithModule() throws Exception {
tb = new ToolBox();
src = Paths.get("src");
initModulesAndPackages();
}
@Test
void testModuleLinkedToModule(Path base) throws Exception {
Path out1 = base.resolve("out1a"), out2 = base.resolve("out1b");
javadoc("-d", out1.toString(),
"--module-source-path", src.toString(),
"--module", "com.ex1");
javadoc("-d", out2.toString(),
"--module-source-path", src.toString(),
"--module", "com.ex2",
"-link", "../" + out1.getFileName());
checkExit(Exit.OK);
checkOutput("com.ex2/com/ex2/B.html", true,
"<a href=\"../../../../out1a/com.ex1/com/ex1/A.html?is-external=true\" "
+ "title=\"class or interface in com.ex1\" class=\"externalLink\">A</a>");
}
@Test
void testPackageLinkedToPackage(Path base) throws Exception {
Path out1 = base.resolve("out2a"), out2 = base.resolve("out2b");
javadoc("-d", out1.toString(),
"-sourcepath", src.toString(),
"-subpackages", "com.ex1");
javadoc("-d", out2.toString(),
"-sourcepath", src.toString(),
"-subpackages", "com.ex2",
"-link", "../" + out1.getFileName());
checkExit(Exit.OK);
checkOutput("com/ex2/B.html", true,
"<a href=\"../../../out2a/com/ex1/A.html?is-external=true\" title=\"class or interface in com.ex1\" "
+ "class=\"externalLink\">A</a>");
}
@Test
void testModuleLinkedToPackage(Path base) throws Exception {
Path out1 = base.resolve("out3a"), out2 = base.resolve("out3b");
javadoc("-d", out1.toString(),
"-sourcepath", src.toString(),
"-subpackages", "com.ex1");
javadoc("-d", out2.toString(),
"--module-source-path", src.toString(),
"--module", "com.ex2",
"-link", "../" + out1.getFileName());
checkExit(Exit.ERROR);
checkOutput(Output.OUT, true,
"The code being documented uses modules but the packages defined "
+ "in ../out3a/ are in the unnamed module");
}
@Test
void testPackageLinkedToModule(Path base) throws Exception {
Path out1 = base.resolve("out4a"), out2 = base.resolve("out4b");
javadoc("-d", out1.toString(),
"--module-source-path", src.toString(),
"--module", "com.ex1");
javadoc("-d", out2.toString(),
"-sourcepath", src.toString(),
"-subpackages", "com.ex2",
"-link", "../" + out1.getFileName());
checkExit(Exit.ERROR);
checkOutput(Output.OUT, true,
"The code being documented uses packages in the unnamed module, but the packages defined "
+ "in ../out4a/ are in named modules");
}
void initModulesAndPackages() throws Exception{
new ModuleBuilder(tb, "com.ex1")
.exports("com.ex1")
.classes("package com.ex1; public class A{}")
.write(src);
new ModuleBuilder(tb, "com.ex2")
.requires("com.ex1")
.exports("com.ex2")
.classes("package com.ex2; \n"
+ "import com.ex1.A;\n"
+ "public class B{\n"
+ "public B(A obj){}\n"
+ "}\n")
.write(src);
new ClassBuilder(tb, "com.ex1.A")
.setModifiers("public","class")
.write(src);
new ClassBuilder(tb, "com.ex2.B")
.addImports("com.ex1.A")
.setModifiers("public","class")
.addMembers(MethodBuilder.parse("public void foo(A a)"))
.write(src);
}
}
|
