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
|
/*
* Copyright (c) 2020, 2023, 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 8258002
* @summary Update "type" terminology in generated docs
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestTerminology
*/
import java.io.IOException;
import java.nio.file.Path;
import javax.lang.model.SourceVersion;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestTerminology extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestTerminology();
tester.runTests();
}
private final ToolBox tb = new ToolBox();
@Test
public void testAnnotationInterface(Path base) throws IOException {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p; /** Comment. */ public @interface A {
int m();
}
"""
);
testAnnotationInterface(base, src, SourceVersion.RELEASE_15);
testAnnotationInterface(base, src, SourceVersion.latest());
}
void testAnnotationInterface(Path base, Path src, SourceVersion sv) {
String v = asOption(sv);
javadoc("-d", base.resolve("out" + v).toString(),
"--source-path", src.toString(),
"--source", v,
"-use",
"p");
checkExit(Exit.OK);
checkOutput("p/A.html", sv.compareTo(SourceVersion.RELEASE_16) < 0,
"""
<h1 title="Annotation Type A" class="title">Annotation Type A</h1>"""
);
checkOutput("p/A.html", sv.compareTo(SourceVersion.RELEASE_16) >= 0,
"""
<h1 title="Annotation Interface A" class="title">Annotation Interface A</h1>"""
);
checkOutput("p/class-use/A.html", sv.compareTo(SourceVersion.RELEASE_16) < 0,
"""
<h1 title="Uses of Annotation Type p.A" class="title">Uses of Annotation Type<br>p.A</h1>"""
);
checkOutput("p/class-use/A.html", sv.compareTo(SourceVersion.RELEASE_16) >= 0,
"""
<h1 title="Uses of Annotation Interface p.A" class="title">Uses of Annotation Interface<br>p.A</h1>"""
);
}
@Test
public void testEnumClass(Path base) throws IOException {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p; /** Comment. */ public enum E { }
"""
);
testEnumClass(base, src, SourceVersion.RELEASE_15);
testEnumClass(base, src, SourceVersion.latest());
}
void testEnumClass(Path base, Path src, SourceVersion sv) {
String v = asOption(sv);
javadoc("-d", base.resolve("out" + v).toString(),
"--source-path", src.toString(),
"--source", v,
"p");
checkExit(Exit.OK);
checkOutput("p/E.html", sv.compareTo(SourceVersion.RELEASE_16) < 0,
"""
<h1 title="Enum E" class="title">Enum E</h1>"""
);
checkOutput("p/E.html", sv.compareTo(SourceVersion.RELEASE_16) >= 0,
"""
<h1 title="Enum Class E" class="title">Enum Class E</h1>"""
);
}
@Test
public void testSearch(Path base) throws IOException {
Path src = base.resolve("src");
tb.writeJavaFiles(src,
"""
package p; /** Comment. */ public class C { }
"""
);
testSearch(base, src, SourceVersion.RELEASE_15);
testSearch(base, src, SourceVersion.latest());
}
public void testSearch(Path base, Path src, SourceVersion sv) {
String v = asOption(sv);
javadoc("-d", base.resolve("out" + v).toString(),
"--source-path", src.toString(),
"--source", v,
"p");
checkExit(Exit.OK);
checkOutput("script-files/search.js", sv.compareTo(SourceVersion.RELEASE_16) < 0,
"""
types: "Types","""
);
checkOutput("script-files/search.js", sv.compareTo(SourceVersion.RELEASE_16) >= 0,
"""
types: "Classes and Interfaces","""
);
}
private String asOption(SourceVersion sv) {
return sv.name().replace("RELEASE_", "");
}
}
|
