Skip to content

Commit 2a74b78

Browse files
rbrirbri
committed
jdoc checkstyle
1 parent 3df1282 commit 2a74b78

26 files changed

+110
-83
lines changed

‎checkstyle.xml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,10 @@
122122

123123
<!-- Checks for Javadoc comments. -->
124124
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
125+
<module name="MissingJavadocMethod"/>
126+
<module name="MissingJavadocPackage"/>
127+
<module name="MissingJavadocType"/>
128+
125129
<module name="JavadocMethod">
126130
<property name="accessModifiers" value="public, protected"/>
127131
</module>
@@ -140,6 +144,14 @@
140144
</module>
141145
<module name="InvalidJavadocPosition"/>
142146
<module name="JavadocContentLocation"/>
147+
<module name="JavadocLeadingAsteriskAlign" />
148+
<!--module name="JavadocMissingLeadingAsterisk"/-->
149+
<!--module name="JavadocMissingWhitespaceAfterAsterisk"/-->
150+
<!--module name="JavadocParagraph"/-->
151+
<!--module name="JavadocTagContinuationIndentation"/-->
152+
<module name="NonEmptyAtclauseDescription"/>
153+
<!--module name="RequireEmptyLineBeforeBlockTagGroup"/-->
154+
<module name="SingleLineJavadoc"/>
143155

144156
<!-- Checks for Naming Conventions. -->
145157
<!-- See http://checkstyle.sf.net/config_naming.html -->

‎pom.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@
208208
<configuration>
209209
<quiet>true</quiet>
210210
<show>protected</show>
211-
<doclint>html,missing,reference,syntax</doclint>
211+
<doclint>html,reference,syntax</doclint>
212212
<detectLinks>true</detectLinks>
213213
<detectJavaApiLink>true</detectJavaApiLink>
214214
<excludePackageNames>org.htmlunit.platform.util</excludePackageNames>
@@ -691,7 +691,7 @@
691691
<configuration>
692692
<quiet>true</quiet>
693693
<show>protected</show>
694-
<doclint>html,missing,reference,syntax</doclint>
694+
<doclint>html,reference,syntax</doclint>
695695
<detectLinks>true</detectLinks>
696696
<detectJavaApiLink>true</detectJavaApiLink>
697697
<excludePackageNames>org.htmlunit.platform.util</excludePackageNames>

‎src/main/java/org/htmlunit/WebWindow.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,8 @@ public interface WebWindow extends Serializable {
187187
Screen getScreen();
188188

189189
/**
190-
* <span style="color:red">INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br>
191-
*
190+
* <span style="color:red">INTERNAL API - SUBJECT TO CHANGE AT ANY TIME - USE AT YOUR OWN RISK.</span><br>
191+
*
192192
* Returns computed style of the element. Computed style represents the final computed values
193193
* of all CSS properties for the element. This method's return value is of the same type as
194194
* that of <code>element.style</code>, but the value returned by this method is read-only.

‎src/main/java/org/htmlunit/javascript/host/Window.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1329,9 +1329,9 @@ public String getName() {
13291329
}
13301330

13311331
/**
1332-
* Sets the value of the window's {@code name} property.
1333-
* @param name the value of the window's {@code name} property
1334-
*/
1332+
* Sets the value of the window's {@code name} property.
1333+
* @param name the value of the window's {@code name} property
1334+
*/
13351335
@JsxSetter
13361336
public void setName(final String name) {
13371337
getWebWindow().setName(name);

‎src/main/java/org/htmlunit/javascript/host/crypto/Crypto.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,9 @@ public SubtleCrypto getSubtle() {
104104
return stuble;
105105
}
106106

107+
/**
108+
* @return a v4 UUID generated using a cryptographically secure random number generator
109+
*/
107110
@JsxFunction
108111
public String randomUUID() {
109112
// Let bytes be a byte sequence of length 16.

‎src/main/java/org/htmlunit/javascript/host/dom/TreeWalker.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -228,13 +228,13 @@ public Node lastChild() {
228228
}
229229

230230
/**
231-
* Moves the TreeWalker to the previous sibling of the current node, and
232-
* returns the new node. If the current node has no visible previous
233-
* sibling, returns {@code null}, and retains the current node.
234-
*
235-
* @return The new node, or {@code null} if the current node has no
236-
* previous sibling in the TreeWalker's logical view.
237-
*/
231+
* Moves the TreeWalker to the previous sibling of the current node, and
232+
* returns the new node. If the current node has no visible previous
233+
* sibling, returns {@code null}, and retains the current node.
234+
*
235+
* @return The new node, or {@code null} if the current node has no
236+
* previous sibling in the TreeWalker's logical view.
237+
*/
238238
@JsxFunction
239239
public Node previousSibling() {
240240
return getNodeOrNull(walker_.previousSibling());

‎src/main/java/org/htmlunit/util/EncodingSniffer.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -292,9 +292,9 @@ public static Charset sniffXmlEncoding(final List<NameValuePair> headers, final
292292
}
293293

294294
/**
295-
* @deprecated as of version 4.0.0; depending on the content use {@link #sniffEncodingFromMetaTag(InputStream)},
296-
* {@link #sniffEncodingFromXmlDeclaration(InputStream)}, or {@link #sniffEncodingFromCssDeclaration(InputStream) }
297-
* instead
295+
* @deprecated as of version 4.0.0; depending on the content use {@link #sniffEncodingFromMetaTag(InputStream)},
296+
* {@link #sniffEncodingFromXmlDeclaration(InputStream)}, or {@link #sniffEncodingFromCssDeclaration(InputStream) }
297+
* instead
298298
*/
299299
@Deprecated
300300
private static Charset sniffCssEncoding(final List<NameValuePair> headers, final InputStream content)

‎src/test/java/org/htmlunit/CacheTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
* @author Ronald Brill
5353
* @author Ashley Frieze
5454
* @author Lai Quang Duong
55-
*/
55+
*/
5656
@RunWith(BrowserRunner.class)
5757
public class CacheTest extends SimpleWebTestCase {
5858

‎src/test/java/org/htmlunit/WebRequest2Test.java‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,9 @@ public void getParametersFromQueryAndUrlEncodedBodyPost() throws Exception {
186186
assertEquals("d", parameters.get(1).getValue());
187187
}
188188

189+
/**
190+
* @throws Exception if the test fails
191+
*/
189192
@Test
190193
public void getParametersFromQueryAndUrlEncodedBodyPostWhenEncodingTypeIsMultipart() throws Exception {
191194
final URL url = new URL(URL_FIRST, "?a=b");
@@ -206,6 +209,9 @@ public void getParametersFromQueryAndUrlEncodedBodyPostWhenEncodingTypeIsMultipa
206209
assertEquals("d", parameters.get(1).getValue());
207210
}
208211

212+
/**
213+
* @throws Exception if the test fails
214+
*/
209215
@Test
210216
public void getParametersUrlEncodedPostNoBody() throws Exception {
211217
final URL url = new URL(URL_FIRST, "?a=b");
@@ -223,6 +229,9 @@ public void getParametersUrlEncodedPostNoBody() throws Exception {
223229
assertEquals("b", parameters.get(0).getValue());
224230
}
225231

232+
/**
233+
* @throws Exception if the test fails
234+
*/
226235
@Test
227236
public void getParametersTextEncodedPostNoBody() throws Exception {
228237
final URL url = new URL(URL_FIRST, "?a=b");
@@ -240,6 +249,9 @@ public void getParametersTextEncodedPostNoBody() throws Exception {
240249
assertEquals("b", parameters.get(0).getValue());
241250
}
242251

252+
/**
253+
* @throws Exception if the test fails
254+
*/
243255
@Test
244256
public void getParametersTextEncodedPostBody() throws Exception {
245257
final URL url = new URL(URL_FIRST, "?a=b");

‎src/test/java/org/htmlunit/html/DomCommentTest.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,9 @@ public void asNormalizedText() throws Exception {
4141
}
4242

4343
/**
44-
* Test the comment correctness.
45-
* @throws Exception if the test fails
46-
*/
44+
* Test the comment correctness.
45+
* @throws Exception if the test fails
46+
*/
4747
@Test
4848
public void asXml() throws Exception {
4949
final String comment = "<!-- a comment -->";
@@ -55,9 +55,9 @@ public void asXml() throws Exception {
5555
}
5656

5757
/**
58-
* Test comment and character data sibling correctness.
59-
* @throws Exception if the test fails
60-
*/
58+
* Test comment and character data sibling correctness.
59+
* @throws Exception if the test fails
60+
*/
6161
@Test
6262
public void textSibling() throws Exception {
6363
final String content = "<html><body id='body'><!-- c1 -->text<!-- c2 --></body></html>";

0 commit comments

Comments
 (0)