View Javadoc
1   package com.google.checkstyle.test.chapter7javadoc.rule713atclauses;
2   
3   import java.io.Serializable;
4   
5   /**
6    * Some javadoc.
7    *
8    * @since Some javadoc.
9    *     Some javadoc.
10   * @version 1.0
11   * @deprecated Some javadoc.
12   *     Some javadoc.
13   * @see Some javadoc.
14   * @author max
15   *     Some javadoc.
16   */
17  class InputJavaDocTagContinuationIndentation implements Serializable {
18    /**
19     * The client's first name.
20     *
21     * @serial Some javadoc.
22     *     Some javadoc.
23     */
24    private String firstName;
25  
26    /**
27     * The client's first name.
28     *
29     * @serial
30     *     Some javadoc.
31     */
32    private String secondName;
33  
34    /**
35     * The client's first name.
36     *
37     * @serialField
38     *     Some javadoc.
39     */
40    private String thirdName;
41  
42    /**
43     * Some text.
44     *
45     * @param str Some javadoc.
46     *     Some javadoc.
47     * @return Some text.
48     * @serialData Some javadoc.
49     * @throws Exception Some text.
50     *    Some javadoc. // violation '.* incorrect indentation level, expected level should be 4.'
51     * @deprecated Some text.
52     */
53    String method(String str) throws Exception {
54      return "null";
55    }
56  
57    /**
58     * Some text.
59     *
60     * @serialData Some javadoc.
61     * @param str Some text.
62     *     Some javadoc.
63     * @return Some text.
64     * @throws Exception Some text.
65     */
66    String method1(String str) throws Exception {
67      return "null";
68    }
69  
70    /**
71     * Some text.
72     *
73     * @param str Some text.
74     *     Some javadoc.
75     * @throws Exception Some text.
76     */
77    void method2(String str) throws Exception {}
78  
79    /**
80     * Some text.
81     *
82     * @throws Exception Some text.
83     * @deprecated Some text.
84     *     Some javadoc.
85     */
86    void method3() throws Exception {}
87  
88    /**
89     * Some text.
90     *
91     * @return Some text.
92     * @throws Exception Some text.
93     */
94    String method4() throws Exception {
95      return "null";
96    }
97  
98    /**
99     * Some text.
100    *
101    * @param str Some text.
102    * @return Some text.
103    * @deprecated Some text.
104    */
105   String method5(String str) {
106     return "null";
107   }
108 
109   /**
110    * Some text.
111    *
112    * @param str Some text.
113    * @param bool Some text.
114    * @param number Some text.
115    *    Some javadoc. // violation '.* incorrect indentation level, expected level should be 4.'
116    * @return Some text.
117    *    Some javadoc. // violation '.* incorrect indentation level, expected level should be 4.'
118    * @serialData Some javadoc.
119    * @throws Exception Some text.
120    * @deprecated Some text.
121    */
122   String method6(String str, int number, boolean bool) throws Exception {
123     return "null";
124   }
125 
126   /**
127    * Some javadoc.
128    *
129    * @version 1.0
130    * @since Some javadoc.
131    * @serialData Some javadoc.
132    * @author max
133    */
134   class InnerClassWithAnnotations {
135     /**
136      * Some text.
137      *
138      * @param str Some text.
139      * @return Some text.
140      * @throws Exception Some text.
141      *     Some javadoc.
142      * @deprecated Some text.
143      *     Some javadoc.
144      */
145     String method(String str) throws Exception {
146       return "null";
147     }
148 
149     /**
150      * Some text.
151      *
152      * @param str Some text.
153      *     Some javadoc.
154      * @return Some text.
155      * @throws Exception Some text.
156      *     Some javadoc.
157      */
158     String method1(String str) throws Exception {
159       return "null";
160     }
161 
162     /**
163      * Some text.
164      *
165      * @serialData Some javadoc.
166      *     Some javadoc.
167      * @param str Some text.
168      *     Some javadoc.
169      * @throws Exception Some text.
170      */
171     void method2(String str) throws Exception {}
172 
173     /**
174      * Some text.
175      *
176      * @throws Exception Some text.
177      * @deprecated Some text.
178      */
179     void method3() throws Exception {}
180 
181     /**
182      * Some text.
183      *
184      * @return Some text.
185      * @throws Exception Some text.
186      * @serialData Some javadoc.
187      */
188     String method4() throws Exception {
189       return "null";
190     }
191 
192     /**
193      * Some text.
194      *
195      * @param str Some text.
196      * @return Some text.
197      * @deprecated Some text.
198      */
199     String method5(String str) {
200       return "null";
201     }
202 
203     /**
204      * Some text.
205      *
206      * @param str Some text.
207      * @param number Some text.
208      *    Some javadoc.
209      *     // violation above '.* incorrect indentation level, expected level should be 4.'
210      * @param bool Some text.
211      *    Some javadoc.
212      *     // violation above '.* incorrect indentation level, expected level should be 4.'
213      * @return Some text.
214      * @throws Exception Some text.
215      * @deprecated Some text.
216      */
217     String method6(String str, int number, boolean bool) throws Exception {
218       return "null";
219     }
220   }
221 
222   InnerClassWithAnnotations anon =
223       new InnerClassWithAnnotations() {
224         /**
225          * Some text.
226          *
227          * @param str Some text.
228          *   Some javadoc.
229          *     // violation above '.* incorrect indentation level, expected level should be 4.'
230          * @return Some text.
231          * @throws Exception Some text.
232          * @serialData Some javadoc.
233          *    Some javadoc.
234          *     // violation above '.* incorrect indentation level, expected level should be 4.'
235          * @deprecated Some text.
236          */
237         String method(String str) throws Exception {
238           return "null";
239         }
240 
241         /**
242          * Some text.
243          *
244          * @param str Some text.
245          *     Some javadoc.
246          * @return Some text.
247          * @throws Exception Some text.
248          */
249         String method1(String str) throws Exception {
250           return "null";
251         }
252 
253         /**
254          * Some text.
255          *
256          * @param str Some text.
257          * @throws Exception Some text.
258          *     Some javadoc.
259          */
260         void method2(String str) throws Exception {}
261 
262         /**
263          * Some text.
264          *
265          * @throws Exception Some text.
266          * @deprecated Some text.
267          *     Some javadoc.
268          */
269         void method3() throws Exception {}
270 
271         /**
272          * Some text.
273          *
274          * @return Some text.
275          * @throws Exception Some text.
276          */
277         String method4() throws Exception {
278           return "null";
279         }
280 
281         /**
282          * Some text.
283          *
284          * @param str Some text.
285          * @return Some text.
286          * @deprecated Some text.
287          */
288         String method5(String str) {
289           return "null";
290         }
291 
292         /**
293          * Some text.
294          *       Some javadoc.
295          *
296          * @param str Some text.
297          *    Some javadoc.
298          *     // violation above '.* incorrect indentation level, expected level should be 4.'
299          * @param number Some text.
300          *    Some javadoc.
301          *     // violation above '.* incorrect indentation level, expected level should be 4.'
302          * @param bool Some text.
303          * @return Some text.
304          * @throws Exception Some text.
305          *    Some javadoc.
306          *     // violation above '.* incorrect indentation level, expected level should be 4.'
307          * @deprecated Some text.
308          */
309         String method6(String str, int number, boolean bool) throws Exception {
310           return "null";
311         }
312       };
313 
314   /**
315    * Some javadoc.
316    *
317    * @since Some javadoc.
318    * @version 1.0
319    * @deprecated Some javadoc.
320    *     Some javadoc.
321    *     Some javadoc.
322    * @see Some javadoc.
323    *    Some javadoc. // violation '.* incorrect indentation level, expected level should be 4.'
324    * @author max
325    */
326   enum Foo3 {}
327 
328   /**
329    * Some javadoc.
330    *
331    * @version 1.0
332    * @since Some javadoc.
333    *     Some javadoc.
334    * @serialData Some javadoc.
335    *   Some javadoc. // violation '.* incorrect indentation level, expected level should be 4.'
336    * @author max
337    */
338   interface FooIn5 {}
339 }