View Javadoc
1   /*xml
2   <module name="Checker">
3     <module name="TreeWalker">
4       <module name="SingleLineJavadoc">
5         <property name="ignoredTags" value="@inheritDoc, @see"/>
6       </module>
7     </module>
8   </module>
9   */
10  package com.puppycrawl.tools.checkstyle.checks.javadoc.singlelinejavadoc;
11  
12  // xdoc section -- start
13  public class Example2 {
14    /** @see Math */
15    public int foo() {
16      return 42;
17    }
18  
19    /**
20     * @return 42
21     */
22    public int bar() {
23      return 42;
24    }
25    //ok below, because inline tag is ignored
26    /** {@link #equals(Object)} */
27    public int baz() {
28      return 42;
29    }
30  
31    /**
32     * <p>the answer to the ultimate question
33     */
34    public int magic() {
35      return 42;
36    }
37  
38    /**
39     * <p>the answer to the ultimate question</p>
40     */
41    public int foobar() {
42      return 42;
43    }
44  }
45  // xdoc section -- end