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