CoCalc -- TestDeprecatedDocs.java

GitHub Repository: PojavLauncherTeam/mobile
Path: blob/master/test/langtools/jdk/javadoc/doclet/testDeprecatedDocs/TestDeprecatedDocs.java
⁴⁰⁹⁷¹ views
1
/*
2
 * Copyright (c) 2003, 2021, Oracle and/or its affiliates. All rights reserved.
3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4
 *
5
 * This code is free software; you can redistribute it and/or modify it
6
 * under the terms of the GNU General Public License version 2 only, as
7
 * published by the Free Software Foundation.
8
 *
9
 * This code is distributed in the hope that it will be useful, but WITHOUT
10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12
 * version 2 for more details (a copy is included in the LICENSE file that
13
 * accompanied this code).
14
 *
15
 * You should have received a copy of the GNU General Public License version
16
 * 2 along with this work; if not, write to the Free Software Foundation,
17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
18
 *
19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
20
 * or visit www.oracle.com if you need additional information or have any
21
 * questions.
22
 */
23

24
/*
25
 * @test
26
 * @bug      4927552 8026567 8071982 8162674 8175200 8175218 8183511 8186332
27
 *           8169819 8074407 8191030 8182765 8184205 8243533 8261976
28
 * @summary  test generated docs for deprecated items
29
 * @library  ../../lib
30
 * @modules jdk.javadoc/jdk.javadoc.internal.tool
31
 * @build    javadoc.tester.*
32
 * @run main TestDeprecatedDocs
33
 */
34

35
import javadoc.tester.JavadocTester;
36

37
public class TestDeprecatedDocs extends JavadocTester {
38

39
    public static void main(String... args) throws Exception {
40
        TestDeprecatedDocs tester = new TestDeprecatedDocs();
41
        tester.runTests();
42
    }
43

44
    @Test
45
    public void test() {
46
        javadoc("-d", "out",
47
                "--no-platform-links",
48
                "-sourcepath", testSrc,
49
                "pkg");
50
        checkExit(Exit.OK);
51

52
        checkOutput("deprecated-list.html", true,
53
                "annotation_test1 passes",
54
                "annotation_test2 passes",
55
                "annotation_test3 passes",
56
                "annotation_test4 passes.",
57
                "class_test1 passes",
58
                "class_test2 passes",
59
                "class_test3 passes",
60
                "class_test4 passes",
61
                "enum_test1 passes",
62
                "enum_test2 passes",
63
                "error_test1 passes",
64
                "error_test2 passes",
65
                "error_test3 passes",
66
                "error_test4 passes",
67
                "exception_test1 passes",
68
                "exception_test2 passes",
69
                "exception_test3 passes",
70
                "exception_test4 passes",
71
                "interface_test1 passes",
72
                "interface_test2 passes",
73
                "interface_test3 passes",
74
                "interface_test4 passes",
75
                "pkg.DeprecatedClassByAnnotation",
76
                "pkg.DeprecatedClassByAnnotation()",
77
                "pkg.DeprecatedClassByAnnotation.method()",
78
                "pkg.DeprecatedClassByAnnotation.field"
79
        );
80

81
        checkOutput("pkg/DeprecatedClassByAnnotation.html", true,
82
                """
83
                    <div class="type-signature"><span class="annotations">@Deprecated
84
                    </span><span class="modifiers">public class </span><span class="element-name type-name-label">DeprecatedClassByAnnotation</span>
85
                    <span class="extends-implements">extends java.lang.Object</span></div>""",
86
                """
87
                    <div class="member-signature"><span class="annotations">@Deprecated(forRemoval=true)
88
                    </span><span class="modifiers">public</span>&nbsp;<span class="return-type">int<\
89
                    /span>&nbsp;<span class="element-name">field</span></div>
90
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
91
                    moval: This API element is subject to removal in a future version.</span></div>""",
92
                """
93
                    <div class="member-signature"><span class="annotations">@Deprecated(forRemoval=true)
94
                    </span><span class="modifiers">public</span>&nbsp;<span class="element-name">DeprecatedClassByAnnotation</span>()</div>
95
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
96
                    moval: This API element is subject to removal in a future version.</span></div>""",
97
                """
98
                    <div class="member-signature"><span class="annotations">@Deprecated
99
                    </span><span class="modifiers">public</span>&nbsp;<span class="return-type">void\
100
                    </span>&nbsp;<span class="element-name">method</span>()</div>
101
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div>""");
102

103
        checkOutput("pkg/TestAnnotationType.html", true,
104
                """
105
                    <hr>
106
                    <div class="type-signature"><span class="annotations">@Deprecated(forRemoval=true)
107
                    @Documented
108
                    </span><span class="modifiers">public @interface </span><span class="element-name type-n\
109
                    ame-label">TestAnnotationType</span></div>
110
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
111
                    moval: This API element is subject to removal in a future version.</span>
112
                    <div class="deprecation-comment">annotation_test1 passes.</div>
113
                    </div>""",
114
                """
115
                    <div class="member-signature"><span class="annotations">@Deprecated(forRemoval=true)
116
                    </span><span class="modifiers">static final</span>&nbsp;<span class="return-type\
117
                    ">int</span>&nbsp;<span class="element-name">field</span></div>
118
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
119
                    moval: This API element is subject to removal in a future version.</span>
120
                    <div class="deprecation-comment">annotation_test4 passes.</div>
121
                    </div>""",
122
                """
123
                    <div class="member-signature"><span class="annotations">@Deprecated(forRemoval=true)
124
                    </span><span class="return-type">int</span>&nbsp;<span class="element-name">required</span></div>
125
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
126
                    moval: This API element is subject to removal in a future version.</span>
127
                    <div class="deprecation-comment">annotation_test3 passes.</div>
128
                    </div>""",
129
                """
130
                    <div class="member-signature"><span class="return-type">java.lang.String</span>&\
131
                    nbsp;<span class="element-name">optional</span></div>
132
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
133
                    <div class="deprecation-comment">annotation_test2 passes.</div>
134
                    </div>""");
135

136
        checkOutput("pkg/TestClass.html", true,
137
                """
138
                    <hr>
139
                    <div class="type-signature"><span class="annotations">@Deprecated(forRemoval=true)
140
                    </span><span class="modifiers">public class </span><span class="element-name type-name-label">TestClass</span>
141
                    <span class="extends-implements">extends java.lang.Object</span></div>
142
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
143
                    moval: This API element is subject to removal in a future version.</span>
144
                    <div class="deprecation-comment">class_test1 passes.</div>
145
                    </div>""",
146
                """
147
                    <div class="member-signature"><span class="annotations">@Deprecated(forRemoval=true)
148
                    </span><span class="modifiers">public</span>&nbsp;<span class="element-name">TestClass</span>()</div>
149
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
150
                    moval: This API element is subject to removal in a future version.</span>
151
                    <div class="deprecation-comment">class_test3 passes. This is the second sentence\
152
                     of deprecated description for a constructor.</div>
153
                    </div>""",
154
                """
155
                    <div class="col-last even-row-color">
156
                    <div class="block"><span class="deprecated-label">Deprecated.</span>
157
                    <div class="deprecation-comment">class_test2 passes.</div>
158
                    </div>
159
                    </div>""",
160
                """
161
                    <div class="col-last even-row-color">
162
                    <div class="block"><span class="deprecated-label">Deprecated, for removal: This \
163
                    API element is subject to removal in a future version.</span>
164
                    <div class="deprecation-comment">class_test3 passes.</div>
165
                    </div>
166
                    </div>""",
167
                """
168
                    <div class="col-last odd-row-color">
169
                    <div class="block"><span class="deprecated-label">Deprecated, for removal: This \
170
                    API element is subject to removal in a future version.</span>
171
                    <div class="deprecation-comment">class_test4 passes.</div>
172
                    </div>
173
                    </div>""",
174
                """
175
                    <div class="col-last even-row-color method-summary-table method-summary-table-ta\
176
                    b2 method-summary-table-tab4 method-summary-table-tab6">
177
                    <div class="block"><span class="deprecated-label">Deprecated.</span>
178
                    <div class="deprecation-comment">class_test5 passes.</div>
179
                    </div>
180
                    </div>""",
181
                """
182
                    <div class="col-last even-row-color method-summary-table method-summary-table-ta\
183
                    b2 method-summary-table-tab4 method-summary-table-tab6">
184
                    <div class="block"><span class="deprecated-label">Deprecated.</span>
185
                    <div class="deprecation-comment">class_test6 passes.</div>
186
                    </div>
187
                    </div>""",
188
                """
189
                    <div class="col-last odd-row-color method-summary-table method-summary-table-tab\
190
                    2 method-summary-table-tab4 method-summary-table-tab6">
191
                    <div class="block"><span class="deprecated-label">Deprecated.</span>
192
                    <div class="deprecation-comment">class_test7 passes.</div>
193
                    </div>
194
                    </div>""");
195

196
        checkOutput("pkg/TestClass.html", false,
197
                """
198
                    <div class="deprecation-comment">class_test2 passes. This is the second sentence\
199
                     of deprecated description for a field.</div>
200
                    </div>
201
                    </div>""",
202
                """
203
                    <div class="deprecation-comment">class_test3 passes. This is the second sentence\
204
                     of deprecated description for a constructor.</div>
205
                    </div>
206
                    </div>""",
207
                """
208
                    <div class="deprecation-comment">class_test4 passes. This is the second sentence\
209
                     of deprecated description for a method.</div>
210
                    </div>
211
                    </div>""");
212

213
        checkOutput("pkg/TestEnum.html", true,
214
                """
215
                    <hr>
216
                    <div class="type-signature"><span class="annotations">@Deprecated(forRemoval=true)
217
                    </span><span class="modifiers">public enum </span><span class="element-name type-name-label">TestEnum</span>
218
                    <span class="extends-implements">extends java.lang.Enum&lt;<a href="TestEnum.htm\
219
                    l" title="enum class in pkg">TestEnum</a>&gt;</span></div>
220
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
221
                    moval: This API element is subject to removal in a future version.</span>
222
                    <div class="deprecation-comment">enum_test1 passes.</div>
223
                    </div>""",
224
                """
225
                    <div class="member-signature"><span class="annotations">@Deprecated(forRemoval=true)
226
                    </span><span class="modifiers">public static final</span>&nbsp;<span class="retu\
227
                    rn-type"><a href="TestEnum.html" title="enum class in pkg">TestEnum</a></span>&nbsp;<s\
228
                    pan class="element-name">FOR_REMOVAL</span></div>
229
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
230
                    moval: This API element is subject to removal in a future version.</span>
231
                    <div class="deprecation-comment">enum_test3 passes.</div>
232
                    </div>""");
233

234
        checkOutput("pkg/TestError.html", true,
235
                """
236
                    <hr>
237
                    <div class="type-signature"><span class="annotations">@Deprecated(forRemoval=true)
238
                    </span><span class="modifiers">public class </span><span class="element-name type-name-label">TestError</span>
239
                    <span class="extends-implements">extends java.lang.Error</span></div>
240
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
241
                    moval: This API element is subject to removal in a future version.</span>
242
                    <div class="deprecation-comment">error_test1 passes.</div>
243
                    </div>""");
244

245
        checkOutput("pkg/TestException.html", true,
246
                """
247
                    <hr>
248
                    <div class="type-signature"><span class="annotations">@Deprecated(forRemoval=true)
249
                    </span><span class="modifiers">public class </span><span class="element-name type-name-label">TestException</span>
250
                    <span class="extends-implements">extends java.lang.Exception</span></div>
251
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
252
                    moval: This API element is subject to removal in a future version.</span>
253
                    <div class="deprecation-comment">exception_test1 passes.</div>
254
                    </div>""");
255

256
        checkOutput("pkg/TestInterface.html", true,
257
                """
258
                    <hr>
259
                    <div class="type-signature"><span class="annotations">@Deprecated(forRemoval=true)
260
                    </span><span class="modifiers">public class </span><span class="element-name type-name-label">TestInterface</span>
261
                    <span class="extends-implements">extends java.lang.Object</span></div>
262
                    <div class="deprecation-block"><span class="deprecated-label">Deprecated, for re\
263
                    moval: This API element is subject to removal in a future version.</span>
264
                    <div class="deprecation-comment">interface_test1 passes.</div>
265
                    </div>""");
266

267
        checkOutput("deprecated-list.html", true,
268
                """
269
                    <ul>
270
                    <li><a href="#for-removal">For Removal</a></li>
271
                    <li><a href="#class">Classes</a></li>
272
                    <li><a href="#enum-class">Enum Classes</a></li>
273
                    <li><a href="#exception">Exceptions</a></li>
274
                    <li><a href="#error">Errors</a></li>
275
                    <li><a href="#annotation-interface">Annotation Interfaces</a></li>
276
                    <li><a href="#field">Fields</a></li>
277
                    <li><a href="#method">Methods</a></li>
278
                    <li><a href="#constructor">Constructors</a></li>
279
                    <li><a href="#enum-constant">Enum Constants</a></li>
280
                    <li><a href="#annotation-interface-member">Annotation Interface Elements</a></li>
281
                    </ul>""",
282
                """
283
                    <div id="for-removal">
284
                    <div class="caption"><span>For Removal</span></div>
285
                    <div class="summary-table two-column-summary">
286
                    <div class="table-header col-first">Element</div>
287
                    <div class="table-header col-last">Description</div>""",
288
                """
289
                    <div id="enum-class">
290
                    <div class="caption"><span>Enum Classes</span></div>
291
                    <div class="summary-table two-column-summary">
292
                    <div class="table-header col-first">Enum Class</div>
293
                    <div class="table-header col-last">Description</div>
294
                    <div class="col-summary-item-name even-row-color"><a href="pkg/TestEnum.html" title="enum class in pkg">pkg.TestEnum</a></div>
295
                    <div class="col-last even-row-color">
296
                    <div class="deprecation-comment">enum_test1 passes.</div>
297
                    </div>""",
298
                """
299
                    <div id="exception">
300
                    <div class="caption"><span>Exceptions</span></div>
301
                    <div class="summary-table two-column-summary">
302
                    <div class="table-header col-first">Exceptions</div>
303
                    <div class="table-header col-last">Description</div>
304
                    <div class="col-summary-item-name even-row-color"><a href="pkg/TestException.html" title="class in pkg">pkg.TestException</a></div>
305
                    <div class="col-last even-row-color">
306
                    <div class="deprecation-comment">exception_test1 passes.</div>
307
                    </div>""",
308
                """
309
                    <div id="field">
310
                    <div class="caption"><span>Fields</span></div>
311
                    <div class="summary-table two-column-summary">
312
                    <div class="table-header col-first">Field</div>
313
                    <div class="table-header col-last">Description</div>
314
                    <div class="col-summary-item-name even-row-color"><a href="pkg/DeprecatedClassByAnnotation.html#field">pkg.DeprecatedClassByAnnotation.field</a></div>
315
                    <div class="col-last even-row-color"></div>
316
                    <div class="col-summary-item-name odd-row-color"><a href="pkg/TestAnnotationType.html#field">pkg.TestAnnotationType.field</a></div>
317
                    <div class="col-last odd-row-color">
318
                    <div class="deprecation-comment">annotation_test4 passes.</div>
319
                    </div>
320
                    <div class="col-summary-item-name even-row-color"><a href="pkg/TestClass.html#field">pkg.TestClass.field</a></div>
321
                    <div class="col-last even-row-color">
322
                    <div class="deprecation-comment">class_test2 passes. This is the second sentence of deprecated description for a field.</div>
323
                    </div>
324
                    <div class="col-summary-item-name odd-row-color"><a href="pkg/TestError.html#field">pkg.TestError.field</a></div>
325
                    <div class="col-last odd-row-color">
326
                    <div class="deprecation-comment">error_test2 passes.</div>
327
                    </div>
328
                    <div class="col-summary-item-name even-row-color"><a href="pkg/TestException.html#field">pkg.TestException.field</a></div>
329
                    <div class="col-last even-row-color">
330
                    <div class="deprecation-comment">exception_test2 passes.</div>
331
                    </div>
332
                    <div class="col-summary-item-name odd-row-color"><a href="pkg/TestInterface.html#field">pkg.TestInterface.field</a></div>
333
                    <div class="col-last odd-row-color">
334
                    <div class="deprecation-comment">interface_test2 passes.</div>
335
                    </div>
336
                    </div>
337
                    </div>""",
338
                """
339
                    <div id="method">
340
                    <div class="caption"><span>Methods</span></div>
341
                    <div class="summary-table two-column-summary">
342
                    <div class="table-header col-first">Method</div>
343
                    <div class="table-header col-last">Description</div>
344
                    <div class="col-summary-item-name even-row-color"><a href="pkg/DeprecatedClassByAnnotation.html#method()">pkg.DeprecatedClassByAnnotation.method()</a></div>
345
                    <div class="col-last even-row-color"></div>
346
                    <div class="col-summary-item-name odd-row-color"><a href="pkg/TestAnnotationType.html#optional()">pkg.TestAnnotationType.optional()</a></div>
347
                    <div class="col-last odd-row-color">
348
                    <div class="deprecation-comment">annotation_test2 passes.</div>
349
                    </div>
350
                    <div class="col-summary-item-name even-row-color"><a href="pkg/TestAnnotationType.html#required()">pkg.TestAnnotationType.required()</a></div>
351
                    <div class="col-last even-row-color">
352
                    <div class="deprecation-comment">annotation_test3 passes.</div>
353
                    </div>
354
                    <div class="col-summary-item-name odd-row-color"><a href="pkg/TestClass.html#method()">pkg.TestClass.method()</a></div>
355
                    <div class="col-last odd-row-color">
356
                    <div class="deprecation-comment">class_test5 passes. This is the second sentence of deprecated description for a method.</div>
357
                    </div>
358
                    <div class="col-summary-item-name even-row-color"><a href="pkg/TestClass.html#overloadedMethod(int)">pkg.TestClass.overloadedMethod<wbr>(int)</a></div>
359
                    <div class="col-last even-row-color">
360
                    <div class="deprecation-comment">class_test7 passes. Overloaded method 2.</div>
361
                    </div>
362
                    <div class="col-summary-item-name odd-row-color"><a href="pkg/TestClass.html#overloadedMethod(java.lang.String)">pkg.TestClass.overloadedMethod<wbr>(String)</a></div>
363
                    <div class="col-last odd-row-color">
364
                    <div class="deprecation-comment">class_test6 passes. Overloaded method 1.</div>
365
                    </div>""",
366
                """
367
                    <div id="constructor">
368
                    <div class="caption"><span>Constructors</span></div>
369
                    <div class="summary-table two-column-summary">
370
                    <div class="table-header col-first">Constructor</div>
371
                    <div class="table-header col-last">Description</div>
372
                    <div class="col-summary-item-name even-row-color"><a href="pkg/DeprecatedClassByAnnotation.html#%3Cinit%3E()">pkg.DeprecatedClassByAnnotation()</a></div>
373
                    <div class="col-last even-row-color"></div>
374
                    <div class="col-summary-item-name odd-row-color"><a href="pkg/TestClass.html#%3Cinit%3E()">pkg.TestClass()</a></div>
375
                    <div class="col-last odd-row-color">
376
                    <div class="deprecation-comment">class_test3 passes. This is the second sentence of deprecated description for a constructor.</div>
377
                    </div>
378
                    <div class="col-summary-item-name even-row-color"><a href="pkg/TestClass.html#%3Cinit%3E(java.lang.String)">pkg.TestClass<wbr>(String)</a></div>
379
                    <div class="col-last even-row-color">
380
                    <div class="deprecation-comment">class_test4 passes. Overloaded constructor.</div>
381
                    </div>""");
382
    }
383
}
384

385
Product

Resources

Company
