1 /*xml
2 <module name="Checker">
3 <module name="TreeWalker">
4 <module name="JavadocMethod"/>
5 </module>
6 </module>
7 */
8 package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocmethod;
9
10 // xdoc section -- start
11 public class Example1 {
12
13 /** */
14 Example1(int x) {}
15 // violation above, 'Expected @param tag for 'x''
16 /** */
17 public int m1(int p1) { return p1; }
18 // 2 violations above:
19 // '@return tag should be present'
20 // 'Expected @param tag for 'p1''
21
22 /**
23 * @param p1 The first number
24 */
25 @Deprecated
26 private int m2(int p1) { return p1; }
27 // violation 2 lines above '@return tag should be present'
28
29 /** */
30 void m3(int p1) {}
31 // violation above, 'Expected @param tag for 'p1''
32 }
33 // xdoc section -- end