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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
/*
* 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 8235414
* @summary Module level doc-files show "unnamed package" as holder
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build javadoc.tester.* toolbox.ToolBox
* @run main TestIndexInDocFiles
*/
import java.io.IOException;
import java.nio.file.Path;
import java.nio.file.Paths;
import toolbox.ToolBox;
import javadoc.tester.JavadocTester;
public class TestIndexInDocFiles extends JavadocTester {
final ToolBox tb;
public static void main(String... args) throws Exception {
var tester = new TestIndexInDocFiles();
tester.runTests();
}
TestIndexInDocFiles() {
tb = new ToolBox();
}
/**
* Test support for index tag and system properties in package level doc-files.
* @param base the base directory for scratch files
* @throws IOException if an exception occurs
*/
@Test
public void testPackageDocFiles(Path base) throws IOException {
Path src = base.resolve("src");
// write the skeletal Java files
tb.writeJavaFiles(src,
"public class A { }\n",
"package p.q; public class C { }\n");
// write the top level (unnamed package) doc file
Path topLevelDocFiles = src.resolve("doc-files");
tb.writeFile(topLevelDocFiles.resolve("top-level-file.html"),
"""
<html>
<head><title>Top level HTML file</title></head>
<body><h1>Package HTML file</h1>
{@index top-level-index additional info}
{@systemProperty top.level.property}
File content</body>
</html>
""");
// write the (named) package level doc file
Path pkgDocFiles = src.resolve("p").resolve("q").resolve("doc-files");
tb.writeFile(pkgDocFiles.resolve("package-file.html"),
"""
<html>
<head><title>Package HTML file</title></head>
<body><h1>Package HTML file</h1>
{@index package-index additional info}
{@systemProperty package.property}
File content</body>
</html>
""");
javadoc("-d", base.resolve("out").toString(),
"--source-path", src.toString(),
src.resolve("A.java").toString(), "p.q");
checkExit(Exit.OK);
checkOutput("doc-files/top-level-file.html", true,
"""
<h1 id="package-html-file-heading">Package HTML file</h1>
<span id="top-level-index" class="search-tag-result">top-level-index</span>
<code><span id="top.level.property" class="search-tag-result">top.level.property</span></code>
""");
checkOutput("p/q/doc-files/package-file.html", true,
"""
<h1 id="package-html-file-heading">Package HTML file</h1>
<span id="package-index" class="search-tag-result">package-index</span>
<code><span id="package.property" class="search-tag-result">package.property</span></code>
""");
checkOutput("tag-search-index.js", true,
"""
{"l":"package-index","h":"package p.q","d":"additional info","u":"p/q/doc-files/package-file.html#package-index"}""",
"""
{"l":"package.property","h":"package p.q","d":"System Property","u":"p/q/doc-files/package-file.html#package.property"}""",
"""
{"l":"top-level-index","h":"unnamed package","d":"additional info","u":"doc-files/top-level-file.html#top-level-index"}""",
"""
{"l":"top.level.property","h":"unnamed package","d":"System Property","u":"doc-f\
iles/top-level-file.html#top.level.property"}""");
}
/**
* Test support for index tags and system properties in module and package level doc-files.
* @param base the base directory for scratch files
* @throws IOException if an exception occurs
*/
@Test
public void testModuleDocFiles(Path base) throws IOException {
Path src = base.resolve("src");
// write the skeletal Java files
tb.writeJavaFiles(src,
"module m.n { exports p.q; }\n",
"public class A { }\n",
"package p.q; public class C { }\n");
// write the doc files for the module
Path mdlDocFiles = src.resolve("doc-files");
tb.writeFile(mdlDocFiles.resolve("module-file.html"),
"""
<html>
<head><title>Module HTML file</title></head>
<body><h1>Module HTML file</h1>
{@index module-index additional info}
{@systemProperty module.property}
File content</body>
</html>
""");
// write the doc files for a package in the module
Path pkgDocFiles = src.resolve("p").resolve("q").resolve("doc-files");
tb.writeFile(pkgDocFiles.resolve("package-file.html"),
"""
<html>
<head><title>Package HTML file</title></head>
<body><h1>Package HTML file</h1>
{@index package-index additional info}
{@systemProperty package.property}
File content</body>
</html>
""");
javadoc("-d", base.resolve("out").toString(),
"--source-path", src.toString(),
"--module", "m.n");
checkExit(Exit.OK);
checkOutput("m.n/doc-files/module-file.html", true,
"""
<h1 id="module-html-file-heading">Module HTML file</h1>
<span id="module-index" class="search-tag-result">module-index</span>
<code><span id="module.property" class="search-tag-result">module.property</span></code>
""");
checkOutput("m.n/p/q/doc-files/package-file.html", true,
"""
<h1 id="package-html-file-heading">Package HTML file</h1>
<span id="package-index" class="search-tag-result">package-index</span>
<code><span id="package.property" class="search-tag-result">package.property</span></code>
""");
checkOutput("tag-search-index.js", true,
"""
{"l":"module-index","h":"module m.n","d":"additional info","u":"m.n/doc-files/module-file.html#module-index"}""",
"""
{"l":"package-index","h":"package p.q","d":"additional info","u":"m.n/p/q/doc-files/package-file.html#package-index"}""",
"""
{"l":"module.property","h":"module m.n","d":"System Property","u":"m.n/doc-files/module-file.html#module.property"}""",
"""
{"l":"package.property","h":"package p.q","d":"System Property","u":"m.n/p/q/doc\
-files/package-file.html#package.property"}""");
}
}
|
