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