* * @param aPath a path for "normalizing" * @return "normalized" file name diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java b/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java index 91502b4bc..9e7a08d10 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java @@ -158,7 +158,7 @@ public class XMLLogger } /** - * Escape <, > & ' and " as their entities. + * Escape <, > & ' and " as their entities. * @param aValue the value to escape. * @return the escaped value if necessary. */ diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/Check.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/Check.java index b57b7f98f..0e33c1784 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/api/Check.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/api/Check.java @@ -26,7 +26,7 @@ import java.util.Set; * * @author Oliver Burn * @version 1.0 - * @see Writing + * @see Writing * your own checks */ public abstract class Check extends AbstractViolationReporter diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java index 0a3d8c7a7..6deb5e882 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/api/TokenTypes.java @@ -501,8 +501,8 @@ public final class TokenTypes * is an optional identifier. * *
For example:
- *- *+ * + * *
parses as:
*
* +--EXTENDS_CLAUSE
@@ -723,7 +723,7 @@ public final class TokenTypes
* +--ELIST
* +--RPAREN ())
*
- *
+ *
*
* @see #IDENT
* @see #TYPE_ARGUMENTS
@@ -1692,7 +1692,7 @@ public final class TokenTypes
* {
* x = rand.nextInt(10);
* }
- * while(x < 5);
+ * while(x < 5);
*
* parses as:
*
@@ -1722,7 +1722,7 @@ public final class TokenTypes
* +--LPAREN (()
* +--EXPR
* |
- * +--LT (<)
+ * +--LT (<)
* |
* +--IDENT (x)
* +--NUM_INT (5)
@@ -2253,7 +2253,7 @@ public final class TokenTypes
**/
public static final int LOR = GeneratedJavaTokenTypes.LOR;
/**
- * The && (conditional AND) operator.
+ * The && (conditional AND) operator.
*
* @see Java
@@ -2280,7 +2280,7 @@ public final class TokenTypes
**/
public static final int BXOR = GeneratedJavaTokenTypes.BXOR;
/**
- * The & (bitwise AND) operator.
+ * The & (bitwise AND) operator.
*
* @see Java
@@ -3207,7 +3207,7 @@ public final class TokenTypes
* +--IDENT (Blah)
* +--TYPE_PARAMETERS
* |
- * +--GENERIC_START (<)
+ * +--GENERIC_START (<)
* +--TYPE_PARAMETER
* |
* +--IDENT (A)
@@ -3215,7 +3215,7 @@ public final class TokenTypes
* +--TYPE_PARAMETER
* |
* +--IDENT (B)
- * +--GENERIC_END (>)
+ * +--GENERIC_END (>)
* +--OBJBLOCK
* |
* +--LCURLY ({)
@@ -3274,7 +3274,7 @@ public final class TokenTypes
* For example:
*
*
- * public Collection a;
+ * public Collection<?> a;
*
*
* parses as:
@@ -3291,11 +3291,11 @@ public final class TokenTypes
* |
* +--TYPE_ARGUMENTS
* |
- * +--GENERIC_START (<)
+ * +--GENERIC_START (<)
* +--TYPE_ARGUMENT
* |
* +--WILDCARD_TYPE (?)
- * +--GENERIC_END (>)
+ * +--GENERIC_END (>)
* +--IDENT (a)
* +--SEMI (;)
*
@@ -3397,8 +3397,8 @@ public final class TokenTypes
public static final int ELLIPSIS = GeneratedJavaTokenTypes.ELLIPSIS;
/**
- * '&' symbol when used in a generic upper or lower bounds constrain
- * e.g. {@code Comparable}.
+ * '&' symbol when used in a generic upper or lower bounds constrain
+ * e.g. {@code Comparable<}.
*/
public static final int TYPE_EXTENSION_AND =
GeneratedJavaTokenTypes.TYPE_EXTENSION_AND;
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java
index f57ed3038..aa8eb2d71 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/TrailingCommentCheck.java
@@ -86,7 +86,7 @@ import org.apache.commons.beanutils.ConversionException;
* His comments on being hard to maintain when the size of
* the line changes are even more important in the age of
* automated refactorings.
- *
+ *
* * To configure the check so it enforces only comment on a line: *
@@ -94,7 +94,7 @@ import org.apache.commons.beanutils.ConversionException; * <property name="format" value="^\\s*$"/> * </module> *- * + * * @author o_sukhodolsky */ public class TrailingCommentCheck extends AbstractFormatCheck diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java index 40689c653..ed6429ab3 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/UpperEllCheck.java @@ -34,7 +34,8 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * Rationale: The letter l looks a lot * like the number 1. * - *
* To configure the check:
*
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationUseStyleCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationUseStyleCheck.java
index a2bf3ac77..174ab348f 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationUseStyleCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/AnnotationUseStyleCheck.java
@@ -37,18 +37,18 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* To not enforce an element style
* a {@link ElementStyle#IGNORE IGNORE} type is provided. The desired style
* can be set through the elementStyle property.
- *
* Using the EXPANDED style is more verbose. The expanded version * is sometimes referred to as "named parameters" in other languages. - *
+ * * ** Using the COMPACT style is less verbose. This style can only * be used when there is an element called 'value' which is either * the sole element or all other elements have default valuess. - *
+ * * ** Using the COMPACT_NO_ARRAY style is less verbose. It is similar @@ -57,7 +57,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * array initializer. This style can only be used when there is an * element called 'value' which is either the sole element or all other * elements have default values. - *
+ * * *
* The ending parenthesis are optional when using annotations with no elements.
@@ -66,7 +66,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* use the {@link ClosingParens#NEVER NEVER} type. To not enforce a
* closing parenthesis preference a {@link ClosingParens#IGNORE IGNORE} type is
* provided. Set this through the closingParens property.
- *
* Annotations also allow you to specify arrays of elements in a standard
@@ -76,16 +76,16 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* {@link TrailingArrayComma#NEVER NEVER} type. To not enforce a trailing
* array comma preference a {@link TrailingArrayComma#IGNORE IGNORE} type
* is provided. Set this through the trailingArrayComma property.
- *
* By default the ElementStyle is set to EXPANDED, the TrailingArrayComma * is set to NEVER, and the ClosingParans is set to ALWAYS. - *
+ * * ** According to the JLS, it is legal to include a trailing comma - * in arrays used in annotations but Sun's Java 5 & 6 compilers will not + * in arrays used in annotations but Sun's Java 5 & 6 compilers will not * compile with this syntax. This may in be a bug in Sun's compilers * since eclipse 3.4's built-in compiler does allow this syntax as * defined in the JLS. Note: this was tested with compilers included with @@ -95,13 +95,13 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * See * Java Language specification, sections 9.7. - *
+ * * ** An example shown below is set to enforce an EXPANDED style, with a * trailing array comma set to NEVER and always including the closing * parenthesis. - *
+ * * *
* <module name="AnnotationUseStyle">
@@ -439,7 +439,7 @@ public final class AnnotationUseStyleCheck extends Check
* compact example
*
* @SuppressWarnings({"unchecked","unused",})
- *
or
+ *
or
* @SuppressWarnings("unchecked").
*/
COMPACT,
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java
index c822fcef9..7fdac9494 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/SuppressWarningsCheck.java
@@ -54,7 +54,7 @@ import com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck;
*
*
* Limitations: This check does not consider conditionals
- * inside the SuppressWarnings annotation.
+ * inside the SuppressWarnings annotation.
* For example:
* {@code @SuppressWarnings((false) ? (true) ? "unchecked" : "foo" : "unused")}
* According to the above example, the "unused" warning is being suppressed
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyOption.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyOption.java
index 7e0420129..ccd2eb002 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyOption.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/LeftCurlyOption.java
@@ -52,12 +52,12 @@ public enum LeftCurlyOption
* But for a statement spanning multiple lines, Checkstyle will enforce:
*
*
- * if (condition1 && condition2 &&
- * condition3 && condition4)
+ * if (condition1 && condition2 &&
+ * condition3 && condition4)
* {
* ...
*
- *
+ *
**/
NLOW,
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java
index ff0c62e5c..4bbe6b9d2 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/DeclarationOrderCheck.java
@@ -32,8 +32,8 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* Code Conventions for the Java Programming Language.
- *
- *
+ *
+ *
*
* - Class (static) variables. First the public class variables, then
* the protected, then package level (no access modifier), and then
@@ -44,10 +44,10 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
*
- Constructors
* - Methods
*
- *
+ *
*
* An example of how to configure the check is:
- *
+ *
*
* <module name="DeclarationOrder"/>
*
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsAvoidNullCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsAvoidNullCheck.java
index 7f09291f6..c6e0a5e66 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsAvoidNullCheck.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/EqualsAvoidNullCheck.java
@@ -52,7 +52,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* "My_Sweet_String".equals(nullString);
*
*
- *
+ *
*
*
* Limitations: If the equals method is overridden or
@@ -61,7 +61,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* as t.equals(s)) then rearranging the called on object and
* parameter may have unexpected results
*
- *
+ *
*
* Java's Autoboxing feature has an affect
* on how this check is implemented. Pre Java 5 all IDENT + IDENT
@@ -69,7 +69,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* if null. Those situations could have been included in this check.
* They would simply act as if they surrounded by String.valueOf()
* which would concatenate the String null.
- *
* The following example will cause a * NullPointerException as a result of what autoboxing does. @@ -78,7 +78,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * String number = "5" * number.equals(i + j); * - *
+ * * * Since, it is difficult to determine what kind of Object is being * concatenated all ident concatenation is considered unsafe. diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NoCloneCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NoCloneCheck.java index 2ec1cb88e..80bcbf4ea 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NoCloneCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NoCloneCheck.java @@ -67,7 +67,7 @@ package com.puppycrawl.tools.checkstyle.checks.coding; * provide a correct clone implementation. * * - * + * * ** Two alternatives to the clone method, in some cases, is a copy constructor @@ -76,7 +76,7 @@ package com.puppycrawl.tools.checkstyle.checks.coding; * force the calling client to handle a CloneNotSupportedException. They also * are typed therefore no casting is necessary. Finally, they are more * flexible since they can take interface types rather than concrete classes. - *
+ * * ** Sometimes a copy constructor or static factory is not an acceptable @@ -108,7 +108,7 @@ package com.puppycrawl.tools.checkstyle.checks.coding; * * Just keep in mind if this type of polymorphic cloning is required * then a properly implemented clone method may be the best choice. - *
+ * * ** Much of this information was taken from Effective Java: @@ -118,7 +118,7 @@ package com.puppycrawl.tools.checkstyle.checks.coding; * *
* This check is almost exactly the same as the {@link NoFinalizerCheck} - *
+ * * * @author Travis Schneeberger * @version 1.0 diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/RequireThisCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/RequireThisCheck.java index c109e7272..caef1a90f 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/RequireThisCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/RequireThisCheck.java @@ -41,7 +41,7 @@ import com.puppycrawl.tools.checkstyle.checks.DeclarationCollector; * <property name="checkMethods" value="true"/> * </module> * - * + * *Limitations: I'm not currently doing anything about static variables * or catch-blocks. Static methods invoked on a class name seem to be OK; * both the class name and the method name have a DOT parent. diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java index fbae952d1..b264f0e34 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/VariableDeclarationUsageDistanceCheck.java @@ -72,7 +72,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * The distance for the variable minutes is 1 even * though this variable is used in the fifth method's call. * - *
+ * ** Case #2: *
@@ -88,7 +88,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * The distance for the variable minutes is 6 because there is one more expression * (except the initialization block) between the declaration of this variable and its usage. *- * + * * * There are several additional options to configure the check: *
@@ -122,11 +122,11 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; ** Case #2: *int sum = 0; - * for (int i = 0; i < 20; i++) { + * for (int i = 0; i < 20; i++) { * a++; * b--; * sum++; - * if (sum > 10) { + * if (sum > 10) { * res = true; * } * }diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java index 5ec3f5375..d2456186e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/design/DesignForExtensionCheck.java @@ -42,7 +42,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; *
* This protects superclasses against being broken by diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/BlockParentHandler.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/BlockParentHandler.java index 7f0d76aab..5a3d700bb 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/BlockParentHandler.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/indentation/BlockParentHandler.java @@ -27,7 +27,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * The "block" handler classes use a common superclass BlockParentHandler, * employing the Template Method pattern. *
- *+ * *
- * - handler class -to-> ID mapping kept in Map + * - handler class -to-> ID mapping kept in Map * - parent passed in during construction * - suggest child indent level * - allows for some tokens to be on same line (ie inner classes OBJBLOCK) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbstractAccessControlNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbstractAccessControlNameCheck.java index f580ae93f..4e979bc44 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbstractAccessControlNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/AbstractAccessControlNameCheck.java @@ -40,7 +40,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; *
* * Examples of line-wrapped statements (bad case): diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java index dfadba246..8b9b965b0 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/whitespace/WhitespaceAroundCheck.java @@ -98,7 +98,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * In addition, this check can be configured to allow empty methods, types, * for, while, do-while loops and constructor bodies. * For example: - *
+ * **
* public MyClass() {} // empty constructor
@@ -108,46 +108,46 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* public enum Foo {} // empty enum
* MyClass c = new MyClass() {}; // empty anonymous class
* while (i = 1) {} // empty while loop
- * for (int i = 1; i > 1; i++) {} // empty for loop
+ * for (int i = 1; i > 1; i++) {} // empty for loop
* do {} while (i = 1); // empty do-while loop
* public @interface Beta {} // empty annotation type
* * To configure the check to allow empty method blocks use - *
+ * **
<property name="allowEmptyMethods" value="true" />- * + * *
* To configure the check to allow empty constructor blocks use - *
+ * **
<property name="allowEmptyConstructors" value="true" />- * + * *
* To configure the check to allow empty type blocks use - *
+ * **
<property name="allowEmptyTypes" value="true" />- * + * *
* To configure the check to allow empty loop blocks use - *
+ * **
<property name="allowEmptyLoops" value="true" />- * + * * *
* Also, this check can be configured to ignore the colon in an enhanced for * loop. The colon in an enhanced for loop is ignored by default - *
+ * ** To configure the check to ignore the colon - *
+ * **
<property name="ignoreEnhancedForColon" value="true" />- * + * * * @author Oliver Burn * @author maxvetrenko diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java index 62c1e84fa..cfae9a3e2 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java @@ -65,10 +65,10 @@ import org.apache.commons.beanutils.ConversionException; * ... * } * - * + * *
* See {@link SuppressionCommentFilter} for usage notes. - *
+ * * * @author Mick Killianey */ diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeInfoPanel.java b/src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeInfoPanel.java index 4d743c055..fcfc7fa3f 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeInfoPanel.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/gui/ParseTreeInfoPanel.java @@ -223,7 +223,6 @@ public class ParseTreeInfoPanel extends JPanel * Parses a file and returns the parse tree. * @param aText the file to parse * @return the root node of the parse tree - * @throws IOException if the file cannot be opened * @throws ANTLRException if the file is not a Java source */ public static DetailAST parseFile(FileText aText)