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
|
/*
* Copyright (c) 2018, 2024, 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 8213957 8213958 8340565
* @summary Test use of at-index in package-iinfo and doc-files
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestIndexInPackageFiles
*/
import java.io.IOException;
import java.nio.file.Path;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestIndexInPackageFiles extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestIndexInPackageFiles ();
tester.runTests();
}
ToolBox tb = new ToolBox();
@Test
public void test() throws IOException {
Path src = Path.of("src");
tb.writeJavaFiles(src,
"""
/**
* Summary.
* {@index test.name.1 additional info}
* {@systemProperty test.property.1}
*/
package p.q;""",
"""
package p.q;
/** This is a class in p.q. */
public class C { }
""");
tb.writeFile(src.resolve("p/q/doc-files/extra.html"),
"""
<html><head><title>Extra</title></head><body>
<h1>Extra</h1>
{@index test.name.2 additional info}
{@systemProperty test.property.2}
</body></html>
""");
tb.writeFile("overview.html",
"""
<html><head><title>Overview</title></head><body>
<h1>Overview</h1>
{@index test.name.3 additional info}
</body></html>
""");
javadoc("-d", "out",
"-sourcepath", src.toString(),
"-overview", "overview.html",
"p.q");
checkExit(Exit.OK);
// Note there is an implicit call to checkLinks, but that only
// checks the links are valid if they are actually present.
// Here, we specifically check for both ends of each link.
// However, we assume the search index files are generated appropriately,
// to match the A-Z index files checked here.
checkOutput("p/q/package-summary.html", true,
"""
<span id="test.name.1" class="search-tag-result">test.name.1</span>""",
"""
<span id="test.property.1" class="search-tag-result">test.property.1</span>""");
checkOutput("p/q/doc-files/extra.html", true,
"""
<span id="test.name.2" class="search-tag-result">test.name.2</span>""",
"""
<span id="test.property.2" class="search-tag-result">test.property.2</span>""");
checkOutput("index.html", true,
"""
<span id="test.name.3" class="search-tag-result">test.name.3</span>""");
checkOutput("index-all.html", true,
"""
<a href="p/q/package-summary.html#test.name.1" class="search-tag-link">test.name.1</a>""",
"""
<a href="p/q/doc-files/extra.html#test.name.2" class="search-tag-link">test.name.2</a>""",
"""
<a href="index.html#test.name.3" class="search-tag-link">test.name.3</a> - Search tag in Overview</dt>""",
"""
<a href="p/q/package-summary.html#test.property.1" class="search-tag-link">test.property.1</a>""",
"""
<a href="p/q/doc-files/extra.html#test.property.2" class="search-tag-link">test.property.2</a>""");
checkOrder("search-tags.html",
"""
<div class="col-first even-row-color">test.name.1</div>
<div class="col-second even-row-color">additional info</div>
<div class="col-last even-row-color">
<div class="block"><code><a href="p/q/package-summary.html#test.name.1">package p.q</a></code></div>""",
"""
<div class="col-first odd-row-color">test.name.2</div>
<div class="col-second odd-row-color">additional info</div>
<div class="col-last odd-row-color">
<div class="block"><a href="p/q/doc-files/extra.html#test.name.2"><code>package p.q: </code>Extra</a></div>""",
"""
<div class="col-first even-row-color">test.name.3</div>
<div class="col-second even-row-color">additional info</div>
<div class="col-last even-row-color">
<div class="block"><a href="index.html#test.name.3">Overview</a></div>""");
}
}
|
