View Javadoc
1   /*xml
2   <module name="Checker">
3     <module name="TreeWalker">
4       <module name="JavadocMethod">
5           <property name="tokens" value="CTOR_DEF"/>
6       </module>
7     </module>
8   </module>
9   */
10  package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocmethod;
11  
12  // xdoc section -- start
13  public class Example6 {
14  
15    /** */
16    Example6(int x) {}
17    // violation above, 'Expected @param tag for 'x''
18    /** */
19    public int m1(int p1) { return p1; }
20    // OK, No missing param tag violation
21    // OK, No missing @return tag violation
22    // only constructors are checked
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  
34  }
35  // xdoc section -- end