1 /*xml
2 <module name="Checker">
3 <module name="TreeWalker">
4 <module name="SummaryJavadoc">
5 <property name="forbiddenSummaryFragments"
6 value="^This method returns.*"/>
7 </module>
8 </module>
9 </module>
10 */
11 package com.puppycrawl.tools.checkstyle.checks.javadoc.summaryjavadoc;
12
13 // xdoc section -- start
14 class Example2 {
15
16 /**
17 * {@inheritDoc}
18 */
19 public String m1(){ return ""; }
20 // violation below, 'Summary javadoc is missing'
21 /** */
22 public String m2(){ return ""; }
23
24 /**
25 * {@summary }
26 */
27 public String m3(){ return ""; }
28 // violation 3 lines above 'Summary javadoc is missing'
29 /**
30 * {@summary <p> <p/>}
31 */
32 public String m4() { return ""; }
33 // violation 3 lines above 'Summary javadoc is missing'
34 /**
35 * {@summary <p>This is a javadoc with period.<p/>}
36 */
37 public void m5() {}
38
39 /**
40 * This method returns nothing.
41 */
42 void m6() {}
43 // violation 4 lines above 'Forbidden summary fragment'
44 /**
45 * {@summary This is a java doc with period symbol。}
46 */
47 public void m7() {}
48 // violation 3 lines above 'Summary of Javadoc is missing an ending period'
49 /**
50 * {@summary First sentence is normally the summary.
51 * Use of html tags:
52 * <ul>
53 * <li>Item one.</li>
54 * <li>Item two.</li>
55 * </ul>}
56 */
57 public void m8() {}
58
59 }
60 // xdoc section -- end