From 693e8820d5a9fefebb8a3fb1661e5fbcb4432cfd Mon Sep 17 00:00:00 2001 From: Michal Kordas Date: Sun, 2 Aug 2015 12:34:28 +0200 Subject: [PATCH] Remove fully qualified class names which can be shortened. #1538 --- .../tools/checkstyle/checks/AbstractFormatCheck.java | 4 ++-- .../com/puppycrawl/tools/checkstyle/checks/CheckUtils.java | 4 ++-- .../checks/annotation/MissingDeprecatedCheck.java | 4 ++-- .../checkstyle/checks/annotation/MissingOverrideCheck.java | 6 +++--- .../tools/checkstyle/checks/blocks/BlockOption.java | 2 +- .../tools/checkstyle/checks/coding/NestedForDepthCheck.java | 4 ++-- .../tools/checkstyle/checks/coding/NoCloneCheck.java | 6 +++--- .../tools/checkstyle/checks/header/RegexpHeaderCheck.java | 4 ++-- .../tools/checkstyle/checks/imports/ImportOrderOption.java | 2 +- .../checkstyle/checks/naming/LocalVariableNameCheck.java | 2 +- .../tools/checkstyle/checks/sizes/ParameterNumberCheck.java | 6 +++--- .../tools/checkstyle/filters/SuppressElement.java | 2 +- .../checkstyle/filters/SuppressWithNearbyCommentFilter.java | 2 +- .../tools/checkstyle/filters/SuppressionCommentFilter.java | 2 +- .../java/com/puppycrawl/tools/checkstyle/gui/FileDrop.java | 2 +- 15 files changed, 26 insertions(+), 26 deletions(-) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/AbstractFormatCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/AbstractFormatCheck.java index 204982249..3bc88cbf0 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/AbstractFormatCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/AbstractFormatCheck.java @@ -28,7 +28,7 @@ import com.puppycrawl.tools.checkstyle.api.Check; /** *

Abstract class for checks that verify strings using a - * {@link java.util.regex.Pattern regular expression}. It + * {@link Pattern regular expression}. It * provides support for setting the regular * expression using the property name format.

* @@ -57,7 +57,7 @@ public abstract class AbstractFormatCheck * Creates a new AbstractFormatCheck instance. * @param defaultFormat default format * @param compileFlags the Pattern flags to compile the regexp with. - * See {@link Pattern#compile(java.lang.String, int)} + * See {@link Pattern#compile(String, int)} * @throws ConversionException unable to parse defaultFormat */ public AbstractFormatCheck(String defaultFormat, int compileFlags) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/CheckUtils.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/CheckUtils.java index 02789eb15..8cceb1cc6 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/CheckUtils.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/CheckUtils.java @@ -140,7 +140,7 @@ public final class CheckUtils { * type. Returns 0 for types other than float, double, int, and long. * @param text the string to be parsed. * @param type the token type of the text. Should be a constant of - * {@link com.puppycrawl.tools.checkstyle.api.TokenTypes}. + * {@link TokenTypes}. * @return the double value represented by the string argument. */ public static double parseDouble(String text, int type) { @@ -229,7 +229,7 @@ public final class CheckUtils { * type. Returns 0 for types other than float, double, int, and long. * @param text the string to be parsed. * @param type the token type of the text. Should be a constant of - * {@link com.puppycrawl.tools.checkstyle.api.TokenTypes}. + * {@link TokenTypes}. * @return the float value represented by the string argument. */ public static double parseFloat(String text, int type) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java index 8e0d5f73a..adb61b416 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingDeprecatedCheck.java @@ -33,14 +33,14 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** *

* This class is used to verify that both the - * {@link java.lang.Deprecated Deprecated} annotation + * {@link Deprecated Deprecated} annotation * and the deprecated javadoc tag are present when * either one is present. *

* *

* Both ways of flagging deprecation serve their own purpose. The - * {@link java.lang.Deprecated Deprecated} annotation is used for + * {@link Deprecated Deprecated} annotation is used for * compilers and development tools. The deprecated javadoc tag is * used to document why something is deprecated and what, if any, * alternatives exist. diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingOverrideCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingOverrideCheck.java index a42735137..14ede99b6 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingOverrideCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingOverrideCheck.java @@ -32,15 +32,15 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; /** *

- * This class is used to verify that the {@link java.lang.Override Override} + * This class is used to verify that the {@link Override Override} * annotation is present when the inheritDoc javadoc tag is present. *

* *

- * Rationale: The {@link java.lang.Override Override} annotation helps + * Rationale: The {@link Override Override} annotation helps * compiler tools ensure that an override is actually occurring. It is * quite easy to accidentally overload a method or hide a static method - * and using the {@link java.lang.Override Override} annotation points + * and using the {@link Override Override} annotation points * out these problems. *

* diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/BlockOption.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/BlockOption.java index 1606e3a78..419743c1d 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/BlockOption.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/blocks/BlockOption.java @@ -22,7 +22,7 @@ package com.puppycrawl.tools.checkstyle.checks.blocks; /** * Represents the policy for checking block statements. * @author Rick Giles - * @see com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck + * @see EmptyBlockCheck */ public enum BlockOption { /** diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NestedForDepthCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NestedForDepthCheck.java index d24b6847a..8d088f77a 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NestedForDepthCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/coding/NestedForDepthCheck.java @@ -38,8 +38,8 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * </module> * * @author Alexander Jesse - * @see com.puppycrawl.tools.checkstyle.checks.coding.AbstractNestedDepthCheck - * @see com.puppycrawl.tools.checkstyle.checks.coding.NestedIfDepthCheck + * @see AbstractNestedDepthCheck + * @see NestedIfDepthCheck */ public final class NestedForDepthCheck extends AbstractNestedDepthCheck { 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 6e5393db9..130e59e5b 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 @@ -122,9 +122,9 @@ package com.puppycrawl.tools.checkstyle.checks.coding; * * * @author Travis Schneeberger - * @see java.lang.Object#clone() - * @see java.lang.Cloneable - * @see java.lang.CloneNotSupportedException + * @see Object#clone() + * @see Cloneable + * @see CloneNotSupportedException */ public class NoCloneCheck extends AbstractIllegalMethodCheck { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/header/RegexpHeaderCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/header/RegexpHeaderCheck.java index 158e79fa9..8df41e1a1 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/header/RegexpHeaderCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/header/RegexpHeaderCheck.java @@ -33,7 +33,7 @@ import com.puppycrawl.tools.checkstyle.Utils; /** * Checks the header of the source against a header file that contains a - * {@link java.util.regex.Pattern regular expression} + * {@link Pattern regular expression} * for each line of the source header. In default configuration, * if header is not specified, the default value of header is set to null * and the check does not rise any violations. @@ -144,7 +144,7 @@ public class RegexpHeaderCheck extends AbstractHeaderCheck { /** * Validates the {@code header} by compiling it with - * {@link Pattern#compile(java.lang.String) } and throws + * {@link Pattern#compile(String) } and throws * {@link PatternSyntaxException} if {@code header} isn't a valid pattern. * @param header the header value to validate and set (in that order) */ diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderOption.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderOption.java index 4569b546c..a754111ca 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderOption.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/imports/ImportOrderOption.java @@ -22,7 +22,7 @@ package com.puppycrawl.tools.checkstyle.checks.imports; /** * Represents the policy for checking import order statements. * @author David DIDIER - * @see com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck + * @see ImportOrderCheck */ public enum ImportOrderOption { /** diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java index 28ca49509..b61fd5091 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/LocalVariableNameCheck.java @@ -30,7 +30,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * Checks that local, non-final variable names conform to a format specified * by the format property. A catch parameter is considered to be * a local variable. The format is a - * {@link java.util.regex.Pattern regular expression} + * {@link Pattern regular expression} * and defaults to * ^[a-z][a-zA-Z0-9]*$. *

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java index 32529acb5..ea3cc28ff 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/ParameterNumberCheck.java @@ -30,7 +30,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * The default allowable number of parameters is 7. * To change the number of allowable parameters, set property max. * Allows to ignore number of parameters for methods with - * @{@link java.lang.Override} annotation. + * @{@link Override} annotation. *

*

* An example of how to configure the check is: @@ -40,7 +40,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes; * *

* An example of how to configure the check to allow 10 parameters - * and ignoring parameters for methods with @{@link java.lang.Override} + * and ignoring parameters for methods with @{@link Override} * annotation is: *

* 
@@ -96,7 +96,7 @@ public class ParameterNumberCheck
 
     /**
      * Ignore number of parameters for methods with
-     * @{@link java.lang.Override} annotation.
+     * @{@link Override} annotation.
      * @param ignoreOverriddenMethods set ignore overridden methods
      */
     public void setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods) {
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressElement.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressElement.java
index a34072c44..bd087ed2b 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressElement.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressElement.java
@@ -27,7 +27,7 @@ import com.puppycrawl.tools.checkstyle.api.AuditEvent;
 import com.puppycrawl.tools.checkstyle.api.Filter;
 
 /**
- * This filter processes {@link com.puppycrawl.tools.checkstyle.api.AuditEvent}
+ * This filter processes {@link AuditEvent}
  * objects based on the criteria of file, check, module id, line, and
  * column. It rejects an AuditEvent if the following match:
  *