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