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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/*
* Copyright (c) 2003, 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 4682448 4947464 5029946 8025633 8026567 8035473 8139101 8175200
8186332 8186703 8182765 8187288
* @summary Verify that the public modifier does not show up in the
* documentation for public methods, as recommended by the JLS.
* If A implements I and B extends A, B should be in the list of
* implementing classes in the documentation for I.
* @author jamieh
* @library ../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build JavadocTester
* @run main TestInterface
*/
/*
* TODO: make it Interface<PE> ie. fix all ParameterTypes, likely should get
* fixed when Doc is replace by j.l.m, but meanwhile this test has been adjusted
* take the current format this is better than @ignore because we can follow the
* differences as the work progress.
*
* The consensus is that we should have something as follows:
* In Child.html
* Specified by: method in interface<IE>
* Overrides: method in class Parent<PE>
* In otherwords the TypeParameter in scope should be used ex: Interface<IE>, Parent<PE>
and Child<CE>
*/
public class TestInterface extends JavadocTester {
public static void main(String... args) throws Exception {
TestInterface tester = new TestInterface();
tester.runTests();
}
@Test
void test() {
javadoc("-d", "out",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkOutput("pkg/Interface.html", true,
"<pre class=\"methodSignature\">int method()</pre>",
"<pre>static final int field</pre>",
// Make sure known implementing class list is correct and omits type parameters.
"<dl>\n"
+ "<dt>All Known Implementing Classes:</dt>\n"
+ "<dd><code><a href=\"Child.html\" title=\"class in pkg\">Child"
+ "</a></code>, <code><a href=\"Parent.html\" title=\"class in pkg\">Parent"
+ "</a></code></dd>\n"
+ "</dl>");
checkOutput("pkg/Child.html", true,
// Make sure "All Implemented Interfaces": has substituted type parameters
"<dl>\n"
+ "<dt>All Implemented Interfaces:</dt>\n"
+ "<dd><code><a href=\"Interface.html\" title=\"interface in pkg\">"
+ "Interface</a><CE></code></dd>\n"
+ "</dl>",
//Make sure Class Tree has substituted type parameters.
"<ul class=\"inheritance\">\n"
+ "<li>java.lang.Object</li>\n"
+ "<li>\n"
+ "<ul class=\"inheritance\">\n"
+ "<li><a href=\"Parent.html\" title=\"class in pkg\">"
+ "pkg.Parent</a><CE></li>\n"
+ "<li>\n"
+ "<ul class=\"inheritance\">\n"
+ "<li>pkg.Child<CE></li>\n"
+ "</ul>\n"
+ "</li>\n"
+ "</ul>\n"
+ "</li>\n"
+ "</ul>",
//Make sure "Specified By" has substituted type parameters.
"<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>\n"
+ "<dd><code><a href=\"Interface.html#method()\">method</a>"
+ "</code> in interface <code>"
+ "<a href=\"Interface.html\" title=\"interface in pkg\">"
+ "Interface</a><<a href=\"Child.html\" title=\"type parameter in Child\">"
+ "CE</a>></code></dd>",
//Make sure "Overrides" has substituted type parameters.
"<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
+ "<dd><code><a href=\"Parent.html#method()\">method</a>"
+ "</code> in class <code><a href=\"Parent.html\" "
+ "title=\"class in pkg\">Parent</a><<a href=\"Child.html\" "
+ "title=\"type parameter in Child\">CE</a>></code></dd>");
checkOutput("pkg/Parent.html", true,
//Make sure "Direct Know Subclasses" omits type parameters
"<dl>\n"
+ "<dt>Direct Known Subclasses:</dt>\n"
+ "<dd><code><a href=\"Child.html\" title=\"class in pkg\">Child"
+ "</a></code></dd>\n"
+ "</dl>");
checkOutput("pkg/Interface.html", false,
"public int method--",
"public static final int field");
checkOutput("pkg/ClassWithStaticMembers.html", false,
//Make sure "Specified By" does not appear on class documentation when
//the method is a static method in the interface.
"<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>\n");
checkOutput("pkg/ClassWithStaticMembers.html", true,
"<h4>f</h4>\n"
+ "<pre>public static int f</pre>\n"
+ "<div class=\"block\">A hider field</div>",
"<td class=\"colFirst\"><code>static void</code></td>\n"
+ "<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\">"
+ "<a href=\"#m()\">m</a></span>()</code></th>\n"
+ "<td class=\"colLast\">\n"
+ "<div class=\"block\">A hider method</div>\n"
+ "</td>\n",
"<h4>staticMethod</h4>\n"
+ "<pre class=\"methodSignature\">public static void staticMethod()</pre>\n"
+ "<div class=\"block\"><span class=\"descfrmTypeLabel\">"
+ "Description copied from interface: <code>"
+ "<a href=\"InterfaceWithStaticMembers.html#staticMethod()\">"
+ "InterfaceWithStaticMembers</a></code></span></div>\n"
+ "<div class=\"block\">A static method</div>\n");
checkOutput("pkg/ClassWithStaticMembers.InnerClass.html", true,
"<pre>public static class <span class=\"typeNameLabel\">"
+ "ClassWithStaticMembers.InnerClass</span>\n"
+ "extends java.lang.Object</pre>\n"
+ "<div class=\"block\">A hider inner class</div>");
}
@Test
void test_html4() {
javadoc("-d", "out-html4",
"-html4",
"-sourcepath", testSrc,
"pkg");
checkExit(Exit.OK);
checkOutput("pkg/Child.html", true,
//Make sure "Specified By" has substituted type parameters.
"<dt><span class=\"overrideSpecifyLabel\">Specified by:</span></dt>\n"
+ "<dd><code><a href=\"Interface.html#method--\">method</a>"
+ "</code> in interface <code>"
+ "<a href=\"Interface.html\" title=\"interface in pkg\">"
+ "Interface</a><<a href=\"Child.html\" title=\"type parameter in Child\">"
+ "CE</a>></code></dd>",
//Make sure "Overrides" has substituted type parameters.
"<dt><span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n"
+ "<dd><code><a href=\"Parent.html#method--\">method</a>"
+ "</code> in class <code><a href=\"Parent.html\" "
+ "title=\"class in pkg\">Parent</a><<a href=\"Child.html\" "
+ "title=\"type parameter in Child\">CE</a>></code></dd>");
checkOutput("pkg/ClassWithStaticMembers.html", true,
"<td class=\"colFirst\"><code>static void</code></td>\n"
+ "<th class=\"colSecond\" scope=\"row\"><code><span class=\"memberNameLink\">"
+ "<a href=\"#m--\">m</a></span>()</code></th>\n"
+ "<td class=\"colLast\">\n"
+ "<div class=\"block\">A hider method</div>\n"
+ "</td>\n",
"<h4>staticMethod</h4>\n"
+ "<pre class=\"methodSignature\">public static void staticMethod()</pre>\n"
+ "<div class=\"block\"><span class=\"descfrmTypeLabel\">"
+ "Description copied from interface: <code>"
+ "<a href=\"InterfaceWithStaticMembers.html#staticMethod--\">"
+ "InterfaceWithStaticMembers</a></code></span></div>\n"
+ "<div class=\"block\">A static method</div>\n");
checkOutput("pkg/Interface.html", false,
"public int method()");
}
@Test
void test1() {
javadoc("-d", "out-1",
"-sourcepath", testSrc,
"pkg1");
checkExit(Exit.OK);
checkOutput("pkg1/Child.html", true,
// Ensure the correct Overrides in the inheritance hierarchy is reported
"<span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n" +
"<dd><code><a href=\"GrandParent.html#method1()\">method1</a></code>" +
" in class " +
"<code><a href=\"GrandParent.html\" title=\"class in pkg1\">GrandParent</a>" +
"<<a href=\"Child.html\" title=\"type parameter in Child\">CE</a>></code>");
}
@Test
void test1_html4() {
javadoc("-d", "out-1-html4",
"-html4",
"-sourcepath", testSrc,
"pkg1");
checkExit(Exit.OK);
checkOutput("pkg1/Child.html", true,
// Ensure the correct Overrides in the inheritance hierarchy is reported
"<span class=\"overrideSpecifyLabel\">Overrides:</span></dt>\n" +
"<dd><code><a href=\"GrandParent.html#method1--\">method1</a></code>" +
" in class " +
"<code><a href=\"GrandParent.html\" title=\"class in pkg1\">GrandParent</a>" +
"<<a href=\"Child.html\" title=\"type parameter in Child\">CE</a>></code>");
}
@Test
void test2() {
javadoc("-d", "out-2",
"-sourcepath", testSrc,
"pkg2");
checkExit(Exit.OK);
checkOutput("pkg2/Spliterator.OfDouble.html", true,
// Ensure the correct type parameters are displayed correctly
"<h3>Nested classes/interfaces inherited from interface pkg2."
+ "<a href=\"Spliterator.html\" title=\"interface in pkg2\">Spliterator</a></h3>\n"
+ "<code><a href=\"Spliterator.OfDouble.html\" title=\"interface in pkg2\">"
+ "Spliterator.OfDouble</a>, <a href=\"Spliterator.OfInt.html\" "
+ "title=\"interface in pkg2\">Spliterator.OfInt</a><"
+ "<a href=\"Spliterator.OfInt.html\" title=\"type parameter in Spliterator.OfInt\">"
+ "Integer</a>>, <a href=\"Spliterator.OfPrimitive.html\" title=\"interface in pkg2\">"
+ "Spliterator.OfPrimitive</a><<a href=\"Spliterator.OfPrimitive.html\" "
+ "title=\"type parameter in Spliterator.OfPrimitive\">T</a>,​<a href=\"Spliterator.OfPrimitive.html\" "
+ "title=\"type parameter in Spliterator.OfPrimitive\">T_CONS</a>,​"
+ "<a href=\"Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"
+ "T_SPLITR</a> extends <a href=\"Spliterator.OfPrimitive.html\" title=\"interface in pkg2\">"
+ "Spliterator.OfPrimitive</a><<a href=\"Spliterator.OfPrimitive.html\" "
+ "title=\"type parameter in Spliterator.OfPrimitive\">T</a>,​"
+ "<a href=\"Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"
+ "T_CONS</a>,​<a href=\"Spliterator.OfPrimitive.html\" title=\"type parameter in Spliterator.OfPrimitive\">"
+ "T_SPLITR</a>>></code>");
}
}
|
