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