checkstyle / jdoc

rbri · rbri · commit 5ee732e8300c · 2025-03-23T14:45:48.000+01:00
diff --git a/checkstyle.xml b/checkstyle.xml
@@ -33,6 +33,7 @@
 
     <module name="LineLength">
         <property name="max" value="120"/>
+        <property name="ignorePattern" value="^(package|import| *\* *[^ ]+).*"/>
     </module>
 
     <!-- Prevent two spaces after @xxxx -->
@@ -99,15 +100,11 @@
         <property name="message" value="Use static import for BrowserVersionFeatures"/>
     </module>
 
-    <!--
-        at the moment there is a problem with disabling this check for some files
-        without disabling all RegexpMultiline checks; for this reason this is not active
     <module name="RegexpMultiline">
         <property name="id" value="sysout"/>
         <property name="format" value="System\s*\.\s*(out)|(err)\s*\.\s*print(ln)?\("/>
         <property name="message" value="System.out.print/ln found"/>
     </module>
-    -->
 
     <module name="TreeWalker">
 
@@ -123,12 +120,12 @@
             <property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
         </module>
 
-        <module name="ConstantName">
-            <property name="format" value="log|^[a-zA-Z][a-zA-Z0-9_]*$"/>
-        </module>
-
         <!-- Checks for Javadoc comments.                     -->
         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
+        <module name="MissingJavadocMethod"/>
+        <module name="MissingJavadocPackage"/>
+        <module name="MissingJavadocType"/>
+
         <module name="JavadocMethod">
             <property name="accessModifiers" value="public, protected"/>
         </module>
@@ -145,9 +142,22 @@
             <property name="checkEmptyJavadoc" value="false"/>
             <property name="checkHtml" value="true"/>
         </module>
+        <module name="InvalidJavadocPosition"/>
+        <module name="JavadocContentLocation"/>
+        <module name="JavadocLeadingAsteriskAlign" />
+        <!--module name="JavadocMissingLeadingAsterisk"/-->
+        <module name="JavadocMissingWhitespaceAfterAsterisk"/>
+        <!--module name="JavadocParagraph"/-->
+        <module name="JavadocTagContinuationIndentation"/>
+        <module name="NonEmptyAtclauseDescription"/>
+        <!--module name="RequireEmptyLineBeforeBlockTagGroup"/-->
+        <module name="SingleLineJavadoc"/>
 
         <!-- Checks for Naming Conventions.                  -->
         <!-- See http://checkstyle.sf.net/config_naming.html -->
+        <module name="CatchParameterName">
+            <property name="format" value="^(ex?|ignored|expected)$"/>
+        </module>
         <module name="LocalFinalVariableName"/>
         <module name="LocalVariableName"/>
         <module name="MethodName">
@@ -162,6 +172,9 @@
         <module name="MemberName">
             <property name="format" value="^[a-z][a-zA-Z0-9_]+_$"/>
         </module>
+        <module name="ConstantName">
+            <property name="format" value="log|^[A-Z][A-Z0-9_]*$"/>
+        </module>
 
         <!-- Checks for imports                               -->
         <!-- See http://checkstyle.sf.net/config_imports.html -->
diff --git a/checkstyle_suppressions.xml b/checkstyle_suppressions.xml
@@ -12,4 +12,8 @@
 
     <suppress checks="." files=".*[\\/]target[\\/]generated-sources[\\/]javacc"/>
     <suppress checks="." files="CssCharStream.java"/>
+    <suppress checks="RegexpMultiline" files="HandlerBase.java"/>
+    <suppress checks="RegexpMultiline" files="LocatorTest.java"/>
+    <suppress checks="RegexpMultiline" files="SerializableTest.java"/>
+
 </suppressions>
diff --git a/src/main/java/org/htmlunit/cssparser/dom/DOMExceptionImpl.java b/src/main/java/org/htmlunit/cssparser/dom/DOMExceptionImpl.java
@@ -58,7 +58,7 @@ public class DOMExceptionImpl extends DOMException {
     /** INSERT_BEFORE_IMPORT = 16. */
     public static final int INSERT_BEFORE_IMPORT = 16;
 
-    static final String[] messages = {
+    static final String[] MESSAGES_ = {
         "Syntax error",
         "Index out of bounds error",
         "This style sheet is read only",
@@ -103,6 +103,6 @@ public DOMExceptionImpl(final int code, final int messageKey) {
      * @param info additional info
      */
     public DOMExceptionImpl(final int code, final int messageKey, final String info) {
-        super((short) code, messages[messageKey] + " (" + info + ")");
+        super((short) code, MESSAGES_[messageKey] + " (" + info + ")");
     }
 }
diff --git a/src/main/java/org/htmlunit/cssparser/parser/AbstractCSSParser.java b/src/main/java/org/htmlunit/cssparser/parser/AbstractCSSParser.java
@@ -39,55 +39,55 @@ public abstract class AbstractCSSParser {
     private CSSErrorHandler errorHandler_;
     private InputSource source_;
 
-    private static final HashMap<String, String> parserMessages_ = new HashMap<>();
+    private static final HashMap<String, String> PARSER_MESSAGES_ = new HashMap<>();
 
     static {
-        parserMessages_.put("invalidExpectingOne", "Invalid token \"{0}\". Was expecting: {1}.");
-        parserMessages_.put("invalidExpectingMore", "Invalid token \"{0}\". Was expecting one of: {1}.");
-        parserMessages_.put("invalidColor", "Invalid color \"{0}\".");
-        parserMessages_.put("invalidStyleSheet", "Error in style sheet.");
-        parserMessages_.put("invalidRule", "Error in rule.");
-        parserMessages_.put("invalidUnknownRule", "Error in unknown at-rule.");
-        parserMessages_.put("invalidCharsetRule", "Error in @charset rule.");
-        parserMessages_.put("misplacedCharsetRule", "The @charset must be the first element in the style sheet.");
-        parserMessages_.put("invalidImportRule", "Error in @import rule.");
-        parserMessages_.put("invalidImportRuleIgnored", "@import rule must occur before all other rules.");
-        parserMessages_.put("invalidImportRuleIgnored2",
+        PARSER_MESSAGES_.put("invalidExpectingOne", "Invalid token \"{0}\". Was expecting: {1}.");
+        PARSER_MESSAGES_.put("invalidExpectingMore", "Invalid token \"{0}\". Was expecting one of: {1}.");
+        PARSER_MESSAGES_.put("invalidColor", "Invalid color \"{0}\".");
+        PARSER_MESSAGES_.put("invalidStyleSheet", "Error in style sheet.");
+        PARSER_MESSAGES_.put("invalidRule", "Error in rule.");
+        PARSER_MESSAGES_.put("invalidUnknownRule", "Error in unknown at-rule.");
+        PARSER_MESSAGES_.put("invalidCharsetRule", "Error in @charset rule.");
+        PARSER_MESSAGES_.put("misplacedCharsetRule", "The @charset must be the first element in the style sheet.");
+        PARSER_MESSAGES_.put("invalidImportRule", "Error in @import rule.");
+        PARSER_MESSAGES_.put("invalidImportRuleIgnored", "@import rule must occur before all other rules.");
+        PARSER_MESSAGES_.put("invalidImportRuleIgnored2",
                                 "@import rule must occur before all other rules, except the @charset rule.");
-        parserMessages_.put("invalidPageRule", "Error in @page rule.");
-        parserMessages_.put("invalidFontFaceRule", "Error in @font-face rule.");
-        parserMessages_.put("invalidMediaList", "Error in media list.");
-        parserMessages_.put("invalidMediaRule", "Error in @media rule.");
-        parserMessages_.put("invalidStyleRule", "Error in style rule.");
-        parserMessages_.put("invalidStyleDeclaration", "Error in style declaration.");
-        parserMessages_.put("invalidDeclaration", "Error in declaration.");
-        parserMessages_.put("invalidDeclarationInvalidChar", "Error in declaration; invalid character \"{0}\" found.");
-        parserMessages_.put("invalidDeclarationStarHack",
+        PARSER_MESSAGES_.put("invalidPageRule", "Error in @page rule.");
+        PARSER_MESSAGES_.put("invalidFontFaceRule", "Error in @font-face rule.");
+        PARSER_MESSAGES_.put("invalidMediaList", "Error in media list.");
+        PARSER_MESSAGES_.put("invalidMediaRule", "Error in @media rule.");
+        PARSER_MESSAGES_.put("invalidStyleRule", "Error in style rule.");
+        PARSER_MESSAGES_.put("invalidStyleDeclaration", "Error in style declaration.");
+        PARSER_MESSAGES_.put("invalidDeclaration", "Error in declaration.");
+        PARSER_MESSAGES_.put("invalidDeclarationInvalidChar", "Error in declaration; invalid character \"{0}\" found.");
+        PARSER_MESSAGES_.put("invalidDeclarationStarHack",
                                     "Error in declaration. ''*'' is not allowed as first char of a property.");
-        parserMessages_.put("invalidSelectorList", "Error in selector list.");
-        parserMessages_.put("invalidSelector", "Error in selector.");
-        parserMessages_.put("invalidSimpleSelector", "Error in simple selector.");
-        parserMessages_.put("invalidClassSelector", "Error in class selector.");
-        parserMessages_.put("invalidElementName", "Error in element name.");
-        parserMessages_.put("invalidAttrib", "Error in attribute selector.");
-        parserMessages_.put("invalidPseudo", "Error in pseudo class or element.");
-        parserMessages_.put("duplicatePseudo", "Duplicate pseudo class \":{0}\" or pseudo class \":{0}\" not at end.");
-        parserMessages_.put("invalidHash", "Error in hash.");
-        parserMessages_.put("invalidExpr", "Error in expression.");
-        parserMessages_.put("invalidExprColon", "Error in expression; '':'' found after identifier \"{0}\".");
-        parserMessages_.put("invalidPrio", "Error in priority.");
-
-        parserMessages_.put("invalidPagePseudoClass",
+        PARSER_MESSAGES_.put("invalidSelectorList", "Error in selector list.");
+        PARSER_MESSAGES_.put("invalidSelector", "Error in selector.");
+        PARSER_MESSAGES_.put("invalidSimpleSelector", "Error in simple selector.");
+        PARSER_MESSAGES_.put("invalidClassSelector", "Error in class selector.");
+        PARSER_MESSAGES_.put("invalidElementName", "Error in element name.");
+        PARSER_MESSAGES_.put("invalidAttrib", "Error in attribute selector.");
+        PARSER_MESSAGES_.put("invalidPseudo", "Error in pseudo class or element.");
+        PARSER_MESSAGES_.put("duplicatePseudo", "Duplicate pseudo class \":{0}\" or pseudo class \":{0}\" not at end.");
+        PARSER_MESSAGES_.put("invalidHash", "Error in hash.");
+        PARSER_MESSAGES_.put("invalidExpr", "Error in expression.");
+        PARSER_MESSAGES_.put("invalidExprColon", "Error in expression; '':'' found after identifier \"{0}\".");
+        PARSER_MESSAGES_.put("invalidPrio", "Error in priority.");
+
+        PARSER_MESSAGES_.put("invalidPagePseudoClass",
                 "Invalid page pseudo class \"{0}\"; valid values are \"blank\", \"first\", \"left\", and \"right\".");
 
-        parserMessages_.put("invalidCaseInSensitivelyIdentifier",
+        PARSER_MESSAGES_.put("invalidCaseInSensitivelyIdentifier",
                 "Invalid case-insensitively identifier \"{0}\" found; valid values are \"i\", and \"s\".");
 
-        parserMessages_.put("ignoringRule", "Ignoring the whole rule.");
-        parserMessages_.put("ignoringFollowingDeclarations", "Ignoring the following declarations in this rule.");
+        PARSER_MESSAGES_.put("ignoringRule", "Ignoring the whole rule.");
+        PARSER_MESSAGES_.put("ignoringFollowingDeclarations", "Ignoring the following declarations in this rule.");
 
-        parserMessages_.put("tokenMgrError", "Lexical error.");
-        parserMessages_.put("domException", "DOM exception: ''{0}''");
+        PARSER_MESSAGES_.put("tokenMgrError", "Lexical error.");
+        PARSER_MESSAGES_.put("domException", "DOM exception: ''{0}''");
     }
 
     private static final String NUM_CHARS = "0123456789.";
@@ -169,7 +169,7 @@ protected InputSource getInputSource() {
      * @return the parser message
      */
     protected String getParserMessage(final String key) {
-        final String msg = parserMessages_.get(key);
+        final String msg = PARSER_MESSAGES_.get(key);
         if (msg == null) {
             return "[[" + key + "]]";
         }
@@ -555,10 +555,10 @@ private static CharStream getCharStream(final InputSource source) throws IOExcep
 
     /**
      * @return a string about which CSS language is supported by this
-     * parser. For CSS Level 1, it returns "http://www.w3.org/TR/REC-CSS1", for
-     * CSS Level 2, it returns "http://www.w3.org/TR/REC-CSS2". Note that a
-     * "CSSx" parser can return lexical unit other than those allowed by CSS
-     * Level x but this usage is not recommended.
+     *      parser. For CSS Level 1, it returns "http://www.w3.org/TR/REC-CSS1", for
+     *      CSS Level 2, it returns "http://www.w3.org/TR/REC-CSS2". Note that a
+     *      "CSSx" parser can return lexical unit other than those allowed by CSS
+     *      Level x but this usage is not recommended.
      */
     public abstract String getParserVersion();
 
diff --git a/src/main/java/org/htmlunit/cssparser/parser/CSSErrorHandler.java b/src/main/java/org/htmlunit/cssparser/parser/CSSErrorHandler.java
@@ -15,9 +15,9 @@
 package org.htmlunit.cssparser.parser;
 
 /**
-  * Interface for CSS parser error handlers.
-  * @author Ronald Brill
-  */
+ * Interface for CSS parser error handlers.
+ * @author Ronald Brill
+ */
 public interface CSSErrorHandler {
 
     /**
diff --git a/src/main/java/org/htmlunit/cssparser/parser/CSSParseException.java b/src/main/java/org/htmlunit/cssparser/parser/CSSParseException.java
@@ -41,7 +41,6 @@ public CSSParseException(final String message, final Locator locator) {
     }
 
     /**
-
      * Wrap an existing exception in a CSSParseException.
      *
      * <p>This constructor is especially useful when an application is
diff --git a/src/main/java/org/htmlunit/cssparser/parser/DocumentHandler.java b/src/main/java/org/htmlunit/cssparser/parser/DocumentHandler.java
@@ -95,7 +95,7 @@ public interface DocumentHandler {
      * @param characterEncoding the character encoding
      * @param locator the locator
      * @throws CSSException Any CSS exception, possibly wrapping another
-     *  exception.
+     *      exception.
      */
     void charset(String characterEncoding, Locator locator) throws CSSException;
 
@@ -105,10 +105,10 @@ public interface DocumentHandler {
      * @param uri The URI of the imported style sheet.
      * @param media The intended destination media for style information.
      * @param defaultNamespaceURI The default namespace URI for the imported
-     *  style sheet.
+     *      style sheet.
      * @param locator the locator
      * @exception CSSException Any CSS exception, possibly wrapping another
-     *  exception.
+     *      exception.
      */
     void importStyle(String uri, MediaQueryList media,
         String defaultNamespaceURI, Locator locator) throws CSSException;
@@ -120,7 +120,7 @@ void importStyle(String uri, MediaQueryList media,
      * @param atRule The complete ignored at-rule.
      * @param locator the locator
      * @exception CSSException Any CSS exception, possibly wrapping another
-     *  exception.
+     *      exception.
      */
     void ignorableAtRule(String atRule, Locator locator) throws CSSException;
 
@@ -133,7 +133,7 @@ void importStyle(String uri, MediaQueryList media,
      *
      * @param locator the locator
      * @exception CSSException Any CSS exception, possibly wrapping another
-     *  exception.
+     *      exception.
      */
     void startFontFace(Locator locator) throws CSSException;
 
@@ -148,7 +148,7 @@ void importStyle(String uri, MediaQueryList media,
      * @param pseudoPage the pseudo page (if any, null otherwise)
      * @param locator the locator
      * @exception CSSException Any CSS exception, possibly wrapping another
-     *  exception.
+     *      exception.
      */
     void startPage(String name, String pseudoPage, Locator locator) throws CSSException;
 
@@ -162,7 +162,7 @@ void importStyle(String uri, MediaQueryList media,
      * @param media The intended destination media for style information.
      * @param locator the locator
      * @exception CSSException Any CSS exception, possibly wrapping another
-     *  exception.
+     *      exception.
      */
     void startMedia(MediaQueryList media, Locator locator) throws CSSException;
 
@@ -172,7 +172,7 @@ void importStyle(String uri, MediaQueryList media,
      * @param selectors All intended selectors for all declarations.
      * @param locator the locator
      * @exception CSSException Any CSS exception, possibly wrapping another
-     *  exception.
+     *     exception.
      */
     void startSelector(SelectorList selectors, Locator locator) throws CSSException;
 
diff --git a/src/main/java/org/htmlunit/cssparser/parser/condition/AttributeCondition.java b/src/main/java/org/htmlunit/cssparser/parser/condition/AttributeCondition.java
@@ -67,6 +67,9 @@ public boolean isCaseInSensitive() {
         return caseInSensitive_ != null && caseInSensitive_.booleanValue();
     }
 
+    /**
+     * @return the operator '='
+     */
     public String getOperator() {
         return "=";
     }
diff --git a/src/main/java/org/htmlunit/cssparser/parser/condition/LangCondition.java b/src/main/java/org/htmlunit/cssparser/parser/condition/LangCondition.java
@@ -20,7 +20,6 @@
 import org.htmlunit.cssparser.parser.Locator;
 
 /**
- *
  * @author Ronald Brill
  */
 public class LangCondition extends AbstractLocatable implements Condition, Serializable {
diff --git a/src/test/java/org/htmlunit/cssparser/parser/CSS3ParserTest.java b/src/test/java/org/htmlunit/cssparser/parser/CSS3ParserTest.java
@@ -2275,7 +2275,8 @@ public void skipInvalidColor() throws Exception {
         assertEquals("*.test { display: block; }", rules.getRules().get(0).getCssText());
         assertEquals("*.another { display: none; }", rules.getRules().get(1).getCssText());
     }
-/**
+
+    /**
      * @throws Exception if any error occurs
      */
     @Test

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,6 @@ public CSSParseException(final String message, final Locator locator) {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`/**`
`44`		`-`
`45`	`44`	`* Wrap an existing exception in a CSSParseException.`
`46`	`45`	`*`
`47`	`46`	`* <p>This constructor is especially useful when an application is`
Original file line number	Diff line number	Diff line change
`@@ -67,6 +67,9 @@ public boolean isCaseInSensitive() {`
`67`	`67`	`return caseInSensitive_ != null && caseInSensitive_.booleanValue();`
`68`	`68`	`}`
`69`	`69`
	`70`	`+ /**`
	`71`	`+ * @return the operator '='`
	`72`	`+ */`
`70`	`73`	`public String getOperator() {`
`71`	`74`	`return "=";`
`72`	`75`	`}`