1 /*
2 SummaryJavadoc
3 violateExecutionOnNonTightHtml = (default)false
4 forbiddenSummaryFragments = ^@return the *|^This method returns *|^A \
5 [{]@code [a-zA-Z0-9]+[}]( is a )
6 period = (default).
7
8
9 */
10
11 package com.puppycrawl.tools.checkstyle.checks.javadoc.summaryjavadoc;
12
13 /**
14 * Some Javadoc A {@code Foo} is a simple Javadoc.
15 */
16 class InputSummaryJavadocCorrect { // ok
17
18 /**
19 * Some Javadoc This method returns.
20 */
21 public static final byte NUL = 0;
22
23 /**
24 * As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)}.
25 */
26 void foo3() {}
27
28 /**
29 * This is valid.
30 * @throws Exception if a problem occurs.
31 */
32 void foo4() throws Exception {}
33
34 /** An especially This method returns short bit of Javadoc. */
35 void foo5() {}
36
37 /**
38 * An especially short
39 * bit of Javadoc. This method returns.
40 */
41 void foo6() {}
42
43 /** {@inheritDoc} */
44 void foo7() {}
45
46 /**
47 * {@inheritDoc} */
48 void foo8() {}
49
50 /**
51 * {@inheritDoc}
52 */
53 void foo9() {}
54
55 /**
56 *
57 *
58 * {@inheritDoc}
59 */
60 void foo10() {}
61
62 /**
63 * {@inheritDoc}mm
64 */
65 void foo9a() {}
66
67 /**
68 * {@inheritDoc}mm.
69 */
70 void foo11() {}
71
72 /**
73 * {@inheritDoc} M m m m
74 */
75 void foo12() {}
76
77 /**
78 * {@inheritDoc} M m m m.
79 */
80 void foo13() {}
81
82 /**
83 * mm. {@inheritDoc}
84 */
85 void foo14() {}
86
87 /**
88 * M m m m. {@inheritDoc}
89 */
90 void foo15() {}
91
92 /**
93 * This is summary java doc.
94 * <a href="mailto:vlad@htmlbook.ru"/>
95 */
96 class InnerInputCorrectJavaDocParagraphCheck {
97
98 /**
99 * foooo@foooo.
100 */
101 public static final byte NUL = 0;
102
103 /**
104 * Some java@doc.
105 * This method returns.
106 */
107 public static final byte NUL_2 = 0;
108
109 /**
110 * Returns the customer ID. This method returns.
111 */
112 int getId() {return 666;}
113
114 /**
115 * This is valid.
116 * <a href="mailto:vlad@htmlbook.ru"/>.
117 */
118 void foo2() {}
119
120 /**
121 * As of JDK 1.1,
122 * replaced by {@link #setBounds(int,int,int,int)}. This method returns.
123 */
124 void foo3() {}
125
126 /**
127 * This is description.
128 * @throws Exception if a problem occurs.
129 */
130 void foo4() throws Exception {}
131
132 /**
133 * JAXB Provider Use Only: Provides partial default
134 * implementations for some javax.xml.bind interfaces.
135 */
136 void foo5() {}
137
138 /**
139 * An especially short (int... A) bit of Javadoc. This
140 * method returns.
141 */
142 void foo6() {}
143 }
144
145 /**
146 * Some
147 * javadoc. A {@code Foo} is a simple Javadoc.
148 *
149 * Some Javadoc. A {@code Foo}
150 * is a simple Javadoc.
151 */
152 InnerInputCorrectJavaDocParagraphCheck anon = new InnerInputCorrectJavaDocParagraphCheck() {
153
154 /**
155 * JAXB 1.0 only default validation event handler.
156 */
157 public static final byte NUL = 0;
158
159 /**
160 * Returns the current state.
161 * This method returns.
162 */
163 boolean emulated(String s) {return false;}
164
165 /**
166 * As of JDK 1.1, replaced by {@link #setBounds(int,int,int,int)}.
167 */
168 void foo3() {}
169
170 /**
171 * This is valid.
172 * @throws Exception if a problem occurs.
173 */
174 void foo4() throws Exception {}
175
176 /** An especially short bit of Javadoc. */
177 void foo5() {}
178
179 /**
180 * An especially short bit of Javadoc.
181 */
182 void foo6() {}
183
184 /**
185 * Some Javadoc. This method returns some javadoc.
186 */
187 boolean emulated() {return false;}
188
189 /**
190 * Some Javadoc. This method returns some javadoc. Some Javadoc.
191 */
192 boolean emulated1() {return false;}
193
194 /**
195 * This is valid.
196 * @return Some Javadoc the customer ID.
197 */
198 int geId() {return 666;}
199
200 /**
201 * This is valid.
202 * @return Sentence one. Sentence two.
203 */
204 String twoSentences() {return "Sentence one. Sentence two.";}
205
206 /** Stop instances being created. **/
207 String twoSentences1() {return "Sentence one. Sentence two.";}
208 };
209 }