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