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     // violation 5 lines below 'Line continuation .* expected level should be 4'
204     /**
205      * Some text.
206      *
207      * @see <a href="https://checkstyle.org/checks/javadoc/javadoctag.html">
208      *    JavadocTagContinuationIndentation: Checks the indentation </a>
209      */
210     String method6() {
211       return "null";
212     }
213 
214     /**
215      * Some text.
216      *
217      * @see <a href="https://checkstyle.org/checks/javadoc/javadoctag.html">
218      *     JavadocTagContinuationIndentation: Checks the indentation </a>
219      */
220     String method7() {
221       return "null";
222     }
223 
224     // violation 5 lines below 'Line continuation .* expected level should be 4'
225     /**
226      * Some text.
227      *
228      * @see reference <a href="https://checkstyle.org/checks/javadoc/javadoctag.html">
229      *    JavadocTagContinuationIndentation: Checks the indentation </a>
230      */
231     String method8() {
232       return "null";
233     }
234 
235     /**
236      * Some text.
237      *
238      * @see reference <a href="https://checkstyle.org/checks/javadoc/javadoctag.html">
239      *     JavadocTagContinuationIndentation: Checks the indentation </a>
240      */
241     String method9() {
242       return "null";
243     }
244 
245     // violation 5 lines below 'Line continuation .* expected level should be 4'
246     /**
247      * Something.
248      *
249      * @param source <a href="https://example.com/data-source">
250      *    Data Source Documentation </a>
251      */
252     String method10() {
253       return "null";
254     }
255 
256     /**
257      * Something.
258      *
259      * @param source <a href="https://example.com/data-source">
260      *     Data Source Documentation </a>
261      */
262     String method11() {
263       return "null";
264     }
265 
266     // violation 6 lines below 'Line continuation .* expected level should be 4'
267     // violation 6 lines below 'Line continuation .* expected level should be 4'
268     /**
269      * Some text.
270      *
271      * @see <a
272      *    href="https://checkstyle.org/checks/javadoc/javadoctag.html">
273      *    JavadocTagContinuationIndentation: Checks the indentation </a>
274      */
275     String method12() {
276       return "null";
277     }
278 
279     /**
280      * Some text.
281      *
282      * @see <a
283      *     href="https://checkstyle.org/checks/javadoc/javadoctag.html">
284      *     JavadocTagContinuationIndentation: Checks the indentation </a>
285      */
286     String method13() {
287       return "null";
288     }
289 
290     /**
291      * Some text.
292      *
293      * @param str Some text.
294      * @param number Some text.
295      *    Some javadoc.
296      *     // violation above '.* incorrect indentation level, expected level should be 4.'
297      * @param bool Some text.
298      *    Some javadoc.
299      *     // violation above '.* incorrect indentation level, expected level should be 4.'
300      * @return Some text.
301      * @throws Exception Some text.
302      * @deprecated Some text.
303      */
304     String method14(String str, int number, boolean bool) throws Exception {
305       return "null";
306     }
307   }
308 
309   InnerClassWithAnnotations anon =
310       new InnerClassWithAnnotations() {
311         /**
312          * Some text.
313          *
314          * @param str Some text.
315          *   Some javadoc.
316          *     // violation above '.* incorrect indentation level, expected level should be 4.'
317          * @return Some text.
318          * @throws Exception Some text.
319          * @serialData Some javadoc.
320          *    Some javadoc.
321          *     // violation above '.* incorrect indentation level, expected level should be 4.'
322          * @deprecated Some text.
323          */
324         String method(String str) throws Exception {
325           return "null";
326         }
327 
328         /**
329          * Some text.
330          *
331          * @param str Some text.
332          *     Some javadoc.
333          * @return Some text.
334          * @throws Exception Some text.
335          */
336         String method1(String str) throws Exception {
337           return "null";
338         }
339 
340         /**
341          * Some text.
342          *
343          * @param str Some text.
344          * @throws Exception Some text.
345          *     Some javadoc.
346          */
347         void method2(String str) throws Exception {}
348 
349         /**
350          * Some text.
351          *
352          * @throws Exception Some text.
353          * @deprecated Some text.
354          *     Some javadoc.
355          */
356         void method3() throws Exception {}
357 
358         /**
359          * Some text.
360          *
361          * @return Some text.
362          * @throws Exception Some text.
363          */
364         String method4() throws Exception {
365           return "null";
366         }
367 
368         /**
369          * Some text.
370          *
371          * @param str Some text.
372          * @return Some text.
373          * @deprecated Some text.
374          */
375         String method5(String str) {
376           return "null";
377         }
378 
379         /**
380          * Some text.
381          *       Some javadoc.
382          *
383          * @param str Some text.
384          *    Some javadoc.
385          *     // violation above '.* incorrect indentation level, expected level should be 4.'
386          * @param number Some text.
387          *    Some javadoc.
388          *     // violation above '.* incorrect indentation level, expected level should be 4.'
389          * @param bool Some text.
390          * @return Some text.
391          * @throws Exception Some text.
392          *    Some javadoc.
393          *     // violation above '.* incorrect indentation level, expected level should be 4.'
394          * @deprecated Some text.
395          */
396         String method6(String str, int number, boolean bool) throws Exception {
397           return "null";
398         }
399       };
400 
401   /**
402    * Some javadoc.
403    *
404    * @since Some javadoc.
405    * @version 1.0
406    * @deprecated Some javadoc.
407    *     Some javadoc.
408    *     Some javadoc.
409    * @see Some javadoc.
410    *    Some javadoc. // violation '.* incorrect indentation level, expected level should be 4.'
411    * @author max
412    */
413   enum Foo3 {}
414 
415   /**
416    * Some javadoc.
417    *
418    * @version 1.0
419    * @since Some javadoc.
420    *     Some javadoc.
421    * @serialData Some javadoc.
422    *   Some javadoc. // violation '.* incorrect indentation level, expected level should be 4.'
423    * @author max
424    */
425   interface FooIn5 {}
426 }