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