View Javadoc
1   /*xml
2   <module name="Checker">
3     <module name="TreeWalker">
4       <module name="NonEmptyAtclauseDescription">
5         <property name="javadocTokens" value="PARAM_LITERAL,THROWS_LITERAL"/>
6       </module>
7     </module>
8   </module>
9   */
10  package com.puppycrawl.tools.checkstyle.checks.javadoc.nonemptyatclausedescription;
11  
12  // xdoc section -- start
13  class Example2 {
14  
15    /**
16     * Some summary.
17     *
18     * @param a Some description
19     * @param b
20     * @deprecated
21     * @throws Exception
22     * @return
23     */
24    public void testMethod(){
25      // violation 6 lines above 'At-clause should have a non-empty description'
26      // @deprecated ignored as not mentioned in javadocTokens
27      // violation 6 lines above 'At-clause should have a non-empty description'
28      // @return ignored as not mentioned in javadocTokens
29    }
30  }
31  // xdoc section -- end