1 /*
2 JavadocStyle
3 scope = (default)private
4 excludeScope = (default)null
5 checkFirstSentence = (default)true
6 endOfSentenceFormat = ([.][ \t\n\r\f<])|([.]$)
7 checkEmptyJavadoc = (default)false
8 checkHtml = false
9 tokens = (default)ANNOTATION_DEF, ANNOTATION_FIELD_DEF, CLASS_DEF, CTOR_DEF, \
10 ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, METHOD_DEF, PACKAGE_DEF, \
11 VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF
12
13
14 */
15
16 package com.puppycrawl.tools.checkstyle.checks.javadoc.javadocstyle;
17
18 public class InputJavadocStyleFirstSentenceFormatTwo
19 {
20 /**
21 * Tags for two lines.
22 * <a href="some_link"
23 * >Link Text</a>
24 */
25 private void method12() {}
26
27 /**
28 * First sentence.
29 * <pre>
30 * +--LITERAL_DO (do)
31 * |
32 * +--SLIST ({)
33 * |
34 * +--EXPR
35 * |
36 * +--ASSIGN (=)
37 * |
38 * +--IDENT (x)
39 * +--METHOD_CALL (()
40 * |
41 * +--DOT (.)
42 * |
43 * +--IDENT (rand)
44 * +--IDENT (nextInt)
45 * +--ELIST
46 * |
47 * +--EXPR
48 * |
49 * +--NUM_INT (10)
50 * +--RPAREN ())
51 * +--SEMI (;)
52 * +--RCURLY (})
53 * +--LPAREN (()
54 * +--EXPR
55 * |
56 * +--LT (<)
57 * |
58 * +--IDENT (x)
59 * +--NUM_INT (5)
60 * +--RPAREN ())
61 * +--SEMI (;)
62 * </pre>
63 */
64 private void method13() {}
65
66 /**
67 * Some problematic javadoc. Sample usage:
68 * <blockquote>
69 */
70
71 private void method14() {}
72
73 // violation below 'First sentence should end with a period.'
74 /**
75 * Empty line between javadoc and method declaration cause wrong
76 * line number for reporting error (bug 841942)
77 */
78
79 private void method15() {}
80
81 /** Description of field: {@value}. */
82 public static final int dummy = 4911;
83
84 /**
85 */
86 public void method16() {}
87
88 /**
89 * @param a A parameter
90 */
91 protected void method17(String a) {}
92
93 /**
94 * @exception RuntimeException should be thrown
95 */
96 void method18(String a) {}
97
98 /**
99 */
100 private static int ASDF = 0;
101
102 /** @see Object */
103 public void method19() {}
104
105 public enum Test
106 {
107 // violation below 'First sentence should end with a period.'
108 /**
109 * Value 1 without a period
110 */
111 value1,
112
113 /**
114 * Value 2 with a period.
115 */
116 value2,
117 }
118 }