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
|
/*
* Copyright (c) 2019, 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 8212233
* @summary The code being documented uses modules but the packages defined in $URL are in the unnamed module.
* @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 javadoc.tester.* toolbox.JarTask toolbox.JavacTask toolbox.ModuleBuilder toolbox.ToolBox
* @run main TestLinkOptionWithAutomaticModule
*/
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import toolbox.JarTask;
import toolbox.JavacTask;
import toolbox.ModuleBuilder;
import toolbox.ToolBox;
import javadoc.tester.JavadocTester;
public class TestLinkOptionWithAutomaticModule extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestLinkOptionWithAutomaticModule();
tester.runTests();
}
final ToolBox tb = new ToolBox();
private Path libJar;
private Path libAPI;
TestLinkOptionWithAutomaticModule() throws IOException {
initLib();
}
private void initLib() throws IOException {
// create library: write source, compile it, jar it
Path lib = Path.of("lib");
Path libSrc = lib.resolve("src");
tb.writeJavaFiles(libSrc, "package lib; public class LibClass { }");
Path libClasses = Files.createDirectories(lib.resolve("classes"));
new JavacTask(tb)
.outdir(libClasses)
.files(tb.findJavaFiles(libSrc))
.run()
.writeAll();
libJar = lib.resolve("MyLib.jar");
new JarTask(tb, libJar)
.baseDir(libClasses)
.files(".")
.run();
libAPI = lib.resolve("api");
javadoc("-d", libAPI.toString(),
"-sourcepath", libSrc.toString(),
"lib");
checkExit(Exit.OK);
}
@Test
public void testLinkUnnamedToAutomaticModule(Path base) throws IOException {
// create API referring to library
Path src = base.resolve("src");
tb.writeJavaFiles(src, "package p; public class MyClass extends lib.LibClass { }");
// run javadoc with library as automatic module
Path api = base.resolve("api");
javadoc("-d", api.toString(),
"-sourcepath", src.toString(),
"--add-modules", "MyLib",
"--module-path", libJar.toString(),
"-linkoffline", "http://myWebsite", libAPI.toAbsolutePath().toString(),
"p");
checkExit(Exit.OK);
checkOutput("p/MyClass.html", true,
"""
extends <a href="http://myWebsite/lib/LibClass.html" title="class or interface i\
n lib" class="external-link">LibClass</a>""");
}
@Test
public void testLinkNamedToAutomaticModule(Path base) throws IOException {
// create API referring to library
Path src = base.resolve("src");
new ModuleBuilder(tb, "my.module")
.exports("p")
.requires("MyLib")
.classes("package p; public class MyClass extends lib.LibClass { }")
.write(src);
// run javadoc with library as automatic module
Path api = base.resolve("api");
javadoc("-d", api.toString(),
"--module-source-path", src.toString(),
"--module-path", libJar.toString(),
"-linkoffline", "http://myWebsite", libAPI.toAbsolutePath().toString(),
"--module", "my.module");
checkExit(Exit.OK);
checkOutput("my.module/p/MyClass.html", true,
"""
extends <a href="http://myWebsite/lib/LibClass.html" title="class or interface i\
n lib" class="external-link">LibClass</a>""");
}
@Test
public void testLinkNamedToUnnamedModule(Path base) throws IOException {
// create API referring to library
Path src = base.resolve("src");
new ModuleBuilder(tb, "my.module")
.exports("p")
.classes("package p; public class MyClass extends lib.LibClass { }")
.write(src);
// run javadoc with library as unnamed module
Path api = base.resolve("api");
javadoc("-d", api.toString(),
"--module-source-path", src.toString(),
"--add-reads", "my.module=ALL-UNNAMED",
"--class-path", libJar.toString(),
"-linkoffline", "http://myWebsite", libAPI.toAbsolutePath().toString(),
"--module", "my.module");
checkExit(Exit.OK);
checkOutput("my.module/p/MyClass.html", true,
"""
extends <a href="http://myWebsite/lib/LibClass.html" title="class or interface i\
n lib" class="external-link">LibClass</a>""");
}
}
|
