-
Notifications
You must be signed in to change notification settings - Fork 91
/
ClassWithNoJavadoc.java
275 lines (240 loc) · 6.31 KB
/
ClassWithNoJavadoc.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
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.
*/
import java.util.Map;
/**
* <p>ClassWithNoJavadoc class.</p>
*
* @author <a href="mailto:vsiveton@apache.org">vsiveton@apache.org</a>
* @version $Id: $
*/
@SuppressWarnings("SameReturnValue")
public class ClassWithNoJavadoc
implements InterfaceWithNoJavadoc
{
/** Constant <code>MY_STRING_CONSTANT="value"</code> */
public static final String MY_STRING_CONSTANT = "value";
/** Constant <code>MY_STRING_CONSTANT2="default value"</code> */
public static final String MY_STRING_CONSTANT2 = "default" + " value";
/** Constant <code>MY_INT_CONSTANT=1</code> */
public static final int MY_INT_CONSTANT = 1;
/** Constant <code>EOL="System.getProperty( line.separator )"</code> */
public static final String EOL = System.getProperty( "line.separator" );
// take care of identifier
private static final String MY_PRIVATE_STRING_CONSTANT = "";
// QDOX-155
/** Constant <code>SEPARATOR=','</code> */
public static final char SEPARATOR = ',';
// QDOX-156
/** Constant <code>TEST1="test1"</code> */
public static final String TEST1 = "test1";
/**
* <p>Constructor for ClassWithNoJavadoc.</p>
*/
public ClassWithNoJavadoc()
{
}
/**
* <p>Constructor for ClassWithNoJavadoc.</p>
*
* @param aString a {@link java.lang.String} object.
*/
public ClassWithNoJavadoc( String aString )
{
}
@SuppressWarnings("SameReturnValue")
/**
* <p>Constructor for ClassWithNoJavadoc.</p>
*
* @param b a {@link java.lang.Boolean} object.
* @since 1.1
*/
public ClassWithNoJavadoc( Boolean b )
{
}
@SuppressWarnings("SameReturnValue")
private ClassWithNoJavadoc( Integer i )
{
}
// take care of primitive
/**
* <p>missingJavadocTagsForPrimitives.</p>
*
* @param i a int.
* @param b a byte.
* @param f a float.
* @param c a char.
* @param s a short.
* @param l a long.
* @param d a double.
* @param bb a boolean.
*/
public void missingJavadocTagsForPrimitives( int i, byte b, float f, char c, short s, long l, double d, boolean bb )
{
}
// take care of object
/**
* <p>missingJavadocTagsForObjects.</p>
*
* @param s a {@link java.lang.String} object.
* @param m a {@link java.util.Map} object.
*/
public void missingJavadocTagsForObjects( String s, Map m )
{
}
// no Javadoc needed
private void privateMethod( String str )
{
}
// ----------------------------------------------------------------------
// New methods to be found by Clirr.
// ----------------------------------------------------------------------
/**
* <p>newClassMethod.</p>
*
* @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 missingJavadoc( String aString )
{
}
// take care of identifier
/** {@inheritDoc} */
public void missingJavadoc2( String aString )
{
}
/** {@inheritDoc} */
public String newInterfaceMethod( String aString )
{
return null;
}
// ----------------------------------------------------------------------
// Inner classes
// ----------------------------------------------------------------------
//No javadoc for inner class.
public class InnerClass
{
public InnerClass()
{
}
public void nothing()
{
}
}
@SuppressWarnings("SameReturnValue")
private void t000()
{
return;
}
//test comment
private void t001()
{
return;
}
/**
* <p>t010.</p>
*
* @since 1.1
*/
@SuppressWarnings("SameReturnValue")
public void t010()
{
return;
}
//test comment
/**
* <p>t011.</p>
*
* @since 1.1
*/
public void t011()
{
return;
}
/**
* <p>testGeneric3.</p>
*
* @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 testGeneric3(Class<T> tClass, Object o)
{
return;
}
/**
* <p>testException0.</p>
*
* @throws java.lang.Exception if any.
* @since 1.1
*/
public void testException0()
throws Exception
{
throw new Exception();
}
/**
* <p>testException1.</p>
*
* @throws java.lang.Exception if any.
* @since 1.1
*/
public void testException1()
throws Exception
{
throw new Exception();
}
/**
* <p>testException2.</p>
*
* @throws java.lang.Exception if any.
* @since 1.1
*/
public void testException2()
throws Exception
{
throw new Exception();
}
/**
* <p>testException3.</p>
*
* @throws java.lang.RuntimeException if any.
* @throws java.lang.Exception if any.
* @since 1.1
*/
public void testException3()
throws RuntimeException , Exception
{
throw new Exception();
}
}
@SuppressWarnings("SameReturnValue")
class PrivateTestClassWithNoJavadoc
{
}