/
ClassWithJavadoc.java
462 lines (418 loc) · 10 KB
/
ClassWithJavadoc.java
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
package fix.test;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* To add default class tags.
*
* @author <a href="mailto:vsiveton@apache.org">vsiveton@apache.org</a>
* @version $Id: $
*/
@SuppressWarnings("SameReturnValue")
public class ClassWithJavadoc
implements InterfaceWithJavadoc
{
/**
* Constructor comment.
*/
public ClassWithJavadoc()
{
}
/**
* <p>Constructor for ClassWithJavadoc.</p>
*
* @param aString a {@link java.lang.String} object.
*/
public ClassWithJavadoc( String aString )
{
}
/**
* public constructor with annotation
*
* @param b a {@link java.lang.Boolean} object.
* @since 1.1
*/
@SuppressWarnings("SameReturnValue")
public ClassWithJavadoc( Boolean b )
{
}
/**
* private constructor with annotation
*/
@SuppressWarnings("SameReturnValue")
private ClassWithJavadoc( Integer i )
{
}
/**
* Spaces in tags.
*
* @param args an array of strings that contains the arguments
*/
public void spacesInJavadocTags( String[] args )
{
}
/**
* <p>missingJavadocTags.</p>
*
* @param str a {@link java.lang.String} object.
* @param b a boolean.
* @param i a int.
* @return a {@link java.lang.String} object.
*/
public String missingJavadocTags( String str, boolean b, int i )
{
return null;
}
/**
* <p>missingJavadocTags2.</p>
*
* @param str a {@link java.lang.String} object.
* @throws java.lang.UnsupportedOperationException if any
* @param b a boolean.
* @param i a int.
* @return a {@link java.lang.String} object.
*/
public String missingJavadocTags2( String str, boolean b, int i )
throws UnsupportedOperationException
{
return null;
}
/**
* <p>wrongJavadocTag.</p>
*
* @param aString a {@link java.lang.String} object.
*/
public void wrongJavadocTag( String aString )
{
}
/**
* <p>multiLinesJavadocTags.</p>
*
* @param aString
* a string
* @param anotherString
* with
* multi
* line
* comments
* @return a
* String
* @throws java.lang.UnsupportedOperationException
* if any
*/
public String multiLinesJavadocTags( String aString, String anotherString )
throws UnsupportedOperationException
{
return null;
}
/**
* To take care of the Javadoc indentation.
*
* @param aString a
* String
* @return dummy
* value
*/
public String wrongJavadocIndentation( String aString )
{
return null;
}
// one single comment
/**
* To take care of single comments.
*
* @param aString a {@link java.lang.String} object.
* @return a {@link java.lang.String} object.
*/
// other single comment
public String singleComments( String aString )
{
return null;
}
/**
* To take care of same comments.
*
* @param aString a string
* @return a string
*/
public String sameString( String aString )
{
return null;
}
/**
* Empty Javadoc tag.
*
* @return a string
* @param aString a {@link java.lang.String} object.
*/
public String emptyJavadocTag( String aString )
{
return null;
}
/**
* Comment on first line.
*
* @param aString a string
* @return a string
*/
public String javadocCommentOnFirstLine( String aString )
{
return null;
}
/**
* Take care of last empty javadoc with unused tags.
*/
public void unusedTag()
{
}
/**
* Take care of RuntimeException.
*
* @throws java.lang.UnsupportedOperationException if any
*/
public void throwsTagWithRuntimeException()
{
}
/**
* Take care of inner RuntimeException.
*
* @throws fix.test.ClassWithJavadoc$MyRuntimeException if any
*/
public void throwsTagWithInnerRuntimeException()
{
}
/**
* Unknown throws RuntimeException.
*
* @throws UnknownRuntimeException if any
*/
public void throwsTagWithUnknownRuntimeException()
{
}
// ----------------------------------------------------------------------
// New methods to be found by Clirr.
// ----------------------------------------------------------------------
/**
* New class method to be found by Clirr.
*
* @param aString a {@link java.lang.String} object.
* @return a {@link java.lang.String} object.
* @since 1.1
*/
public String newClassMethod( String aString )
{
return null;
}
// ----------------------------------------------------------------------
// Inheritance
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void method1( String aString )
{
}
/**
* {@inheritDoc}
*
* specific comment
*/
public void method2( String aString )
{
}
/** {@inheritDoc} */
public String method3( String aString )
{
return null;
}
/** {@inheritDoc} */
public String method4( String aString )
{
return null;
}
/**
* {@inheritDoc}
*
* Specific comment
*/
public String method5( String aString )
{
return null;
}
/**
* {@inheritDoc}
*
* New interface method to be found by Clirr.
*/
public String newInterfaceMethod( String aString )
{
return null;
}
// ----------------------------------------------------------------------
// Inner classes
// ----------------------------------------------------------------------
/**
* No javadoc for inner class.
*/
public class InnerClass
{
/**
* constructor
*/
public InnerClass()
{
}
public void nothing()
{
}
}
/**
* RuntimeException
*/
public static class MyRuntimeException
extends RuntimeException
{
}
/**
* private method with annotation
*/
@SuppressWarnings("SameReturnValue")
private void t000()
{
return;
}
/**
* private method with line comment
*/
//test comment
private void t001()
{
return;
}
/**
* public method with annotation
*
* @since 1.1
*/
@SuppressWarnings("SameReturnValue")
public void t010()
{
return;
}
/**
* public method with annotation
*
* @since 1.1
*/
//test comment
public void t011()
{
return;
}
/**
* test generic function (with only head javadoc)
*
* @param tClass a {@link java.lang.Class} object.
* @param o a {@link java.lang.Object} object.
* @param <T> a T class.
* @since 1.1
*/
public <T extends Object> void testGeneric0(Class<T> tClass, Object o)
{
return;
}
/**
* test generic function (with full javadoc)
*
* @param tClass a {@link java.lang.Class} object.
* @param o a {@link java.lang.Object} object.
* @param <T> a T class.
* @since 1.1
*/
public <T extends Object> void testGeneric1(Class<T> tClass, Object o)
{
return;
}
/**
* test generic function (with full javadoc, except generic docs)
*
* @param tClass a {@link java.lang.Class} object.
* @param o a {@link java.lang.Object} object.
* @param <T> a T class.
* @since 1.1
*/
public <T extends Object> void testGeneric2(Class<T> tClass, Object o)
{
return;
}
/**
* test whether it will change exception description when using "fix"
* test if we use fully qualified name for the exception.
*
* @throws java.lang.Exception original description, should not be changed to "if any".
* @since 1.1
*/
public void testException0()
throws Exception
{
throw new Exception();
}
/**
* test whether it will change exception description when using "fix"
* test if we use short name for the exception.
*
* @throws java.lang.Exception original description, should not be changed to "if any".
* @since 1.1
*/
public void testException1()
throws Exception
{
throw new Exception();
}
/**
* test whether it will change exception description when using "fix"
* test if we use a wrong name for the exception.
*
* @throws RuaaaaaaException abcdefghijklmn.
* @throws java.lang.Exception if any.
* @since 1.1
*/
public void testException2()
throws Exception
{
throw new Exception();
}
/**
* test whether it will change exception description when using "fix"
* test if we provide only one exception description.
*
* @throws java.lang.RuntimeException text.
* @throws java.lang.Exception if any.
* @since 1.1
*/
public void testException3()
throws RuntimeException , Exception
{
throw new Exception();
}
}
/**
* To test package class
*/
@SuppressWarnings("SameReturnValue")
class PrivateTestClassWithJavadoc
{
}