1 /*xml
2 <module name="Checker">
3 <module name="TreeWalker">
4 <module name="JavadocStyle"/>
5 </module>
6 </module>
7 */
8 package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle;
9
10 // xdoc section -- start
11 /**
12 * Some description here
13 */
14 public class Example1 {
15 Example1() {
16 // violation 5 lines above 'First sentence should end with a period'
17 }
18 /**
19 * Some description here.
20 */
21 private void testMethod1() {}
22 // ok below, @return tag automatically inserts a period after the text
23 /**
24 * {@return {@code true} if this object
25 * has been initialized, {@code false} otherwise}
26 */
27 private boolean testMethod2() {
28 return true;
29 }
30 /**
31 * Some description here
32 */
33 private void testMethod3() {
34 // violation 4 lines above 'First sentence should end with a period'
35 }
36 /**
37 * Some description here
38 */
39 public void testMethod4() {
40 // violation 4 lines above 'First sentence should end with a period'
41 }
42 /**
43 * Some description here
44 * Second line of description
45 */
46 private void testMethod5() {
47 // violation 5 lines above 'First sentence should end with a period'
48 }
49 /**
50 * Some description here
51 * <p
52 */
53 private void testMethod6() { // violation 4 lines above 'should end with a period'
54 // violation 3 lines above 'Incomplete HTML tag found'
55 }
56 }
57 // xdoc section -- end