diff --git a/config/checkstyle_checks.xml b/config/checkstyle_checks.xml index 0e9ab6975..7a8246ccf 100644 --- a/config/checkstyle_checks.xml +++ b/config/checkstyle_checks.xml @@ -226,6 +226,7 @@ + @@ -236,7 +237,6 @@ - diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/CheckStyleTask.java b/src/main/java/com/puppycrawl/tools/checkstyle/CheckStyleTask.java index a08123ab3..07fc18af4 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/CheckStyleTask.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/CheckStyleTask.java @@ -567,8 +567,8 @@ public class CheckStyleTask extends Task } /** - * @return a DefaultLogger instance * @param task the task to possibly log to + * @return a DefaultLogger instance * @throws IOException if an error occurs */ private AuditListener createDefaultLogger(Task task) @@ -583,8 +583,8 @@ public class CheckStyleTask extends Task } /** - * @return an XMLLogger instance * @param task the task to possibly log to + * @return an XMLLogger instance * @throws IOException if an error occurs */ private AuditListener createXMLLogger(Task task) throws IOException diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/ConfigurationLoader.java b/src/main/java/com/puppycrawl/tools/checkstyle/ConfigurationLoader.java index a266f7c35..2542ec97e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/ConfigurationLoader.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/ConfigurationLoader.java @@ -440,11 +440,11 @@ public final class ConfigurationLoader * @param defaultValue default to use if one of the properties in value * cannot be resolved from props. * + * @return the original string with the properties replaced, or + * null if the original string is null. * @throws CheckstyleException if the string contains an opening * ${ without a closing * } - * @return the original string with the properties replaced, or - * null if the original string is null. * * Code copied from ant - * http://cvs.apache.org/viewcvs/jakarta-ant/src/main/org/apache/tools/ant/ProjectHelper.java diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/Main.java b/src/main/java/com/puppycrawl/tools/checkstyle/Main.java index 307ddc677..bf30aa4da 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/Main.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/Main.java @@ -80,10 +80,10 @@ public final class Main * Parses and executes Checkstyle based on passed arguments. * @param args * command line parameters + * @return parsed information about passed parameters * @throws ParseException * when passed arguments are not valid * @exception CheckstyleException when provided parameters are not supported - * @return parsed information about passed parameters */ private static CommandLine parseCli(String[] args) throws ParseException diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/PropertyCacheFile.java b/src/main/java/com/puppycrawl/tools/checkstyle/PropertyCacheFile.java index c67fe7b98..99cfe9426 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/PropertyCacheFile.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/PropertyCacheFile.java @@ -146,9 +146,9 @@ final class PropertyCacheFile } /** - * @return whether the specified file has already been checked ok * @param fileName the file to check * @param timestamp the timestamp of the file to check + * @return whether the specified file has already been checked ok */ boolean alreadyChecked(String fileName, long timestamp) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/PropertyResolver.java b/src/main/java/com/puppycrawl/tools/checkstyle/PropertyResolver.java index 6baabb31f..8c3996cea 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/PropertyResolver.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/PropertyResolver.java @@ -27,8 +27,8 @@ import com.puppycrawl.tools.checkstyle.api.CheckstyleException; * resolve the values of external properties like ${basename} * that occur in the configuration file. * - * @see ConfigurationLoader * @author lkuehne + * @see ConfigurationLoader */ public interface PropertyResolver { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/TreeWalker.java b/src/main/java/com/puppycrawl/tools/checkstyle/TreeWalker.java index fb83aefff..e35517fa6 100755 --- a/src/main/java/com/puppycrawl/tools/checkstyle/TreeWalker.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/TreeWalker.java @@ -447,11 +447,11 @@ public final class TreeWalker * * @param contents * contains the contents of the file + * @return the root of the AST * @throws TokenStreamException * if lexing failed * @throws RecognitionException * if parsing failed - * @return the root of the AST */ public static DetailAST parse(FileContents contents) throws RecognitionException, TokenStreamException diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/Utils.java b/src/main/java/com/puppycrawl/tools/checkstyle/Utils.java index 125151e76..77d4916f3 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/Utils.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/Utils.java @@ -174,8 +174,8 @@ public final class Utils } /** - * @return the base class name from a fully qualified name * @param type the fully qualified name. Cannot be null + * @return the base class name from a fully qualified name */ public static String baseClassname(String type) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java b/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java index a63473e24..940ec04f1 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/XMLLogger.java @@ -206,8 +206,8 @@ public class XMLLogger } /** - * @return whether the given argument a character or entity reference * @param ent the possible entity to look for. + * @return whether the given argument a character or entity reference */ public boolean isReference(String ent) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java index 8b27e2839..7c730f9c8 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/api/FileContents.java @@ -176,11 +176,11 @@ public final class FileContents implements CommentListener /** * Returns the specified C comment as a String array. - * @return C comment as a array * @param startLineNo the starting line number * @param startColNo the starting column number * @param endLineNo the ending line number * @param endColNo the ending column number + * @return C comment as a array **/ private String[] extractCComment(int startLineNo, int startColNo, int endLineNo, int endColNo) @@ -206,8 +206,8 @@ public final class FileContents implements CommentListener /** * Returns the Javadoc comment before the specified line. * A return value of null means there is no such comment. - * @return the Javadoc comment, or null if none * @param lineNoBefore the line number to check before + * @return the Javadoc comment, or null if none **/ public TextBlock getJavadocBefore(int lineNoBefore) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java b/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java index 71dd46724..68f6cc31e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.java @@ -21,9 +21,9 @@ package com.puppycrawl.tools.checkstyle.api; import com.puppycrawl.tools.checkstyle.grammars.javadoc.JavadocParser; /** + * @author Baratali Izmailov * @see * javadoc - The Java API Documentation Generator - * @author Baratali Izmailov */ public final class JavadocTokenTypes { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/AbstractOptionCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/AbstractOptionCheck.java index d3704a4c5..823804886 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/AbstractOptionCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/AbstractOptionCheck.java @@ -30,9 +30,9 @@ import com.puppycrawl.tools.checkstyle.api.Check; * representation to the {@link Enum} is to {@link String#trim()} the string * and convert using {@link String#toUpperCase()} and then look up using * {@link Enum#valueOf}. - * @param the type of the option. * @author Oliver Burn * @author Rick Giles + * @param the type of the option. */ public abstract class AbstractOptionCheck> extends Check diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/ClassResolver.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/ClassResolver.java index ee1867f61..5f384bc80 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/ClassResolver.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/ClassResolver.java @@ -122,8 +122,8 @@ public class ClassResolver } /** - * @return whether a specified class is loadable with safeLoad(). * @param name name of the class to check + * @return whether a specified class is loadable with safeLoad(). */ public boolean isLoadable(String name) { 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 84ee95639..57904964a 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 @@ -20,8 +20,8 @@ package com.puppycrawl.tools.checkstyle.checks.blocks; /** * Represents the policy for checking block statements. - * @see com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck * @author Rick Giles + * @see com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck */ public enum BlockOption { 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 0d823f8e5..773d23818 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 @@ -20,8 +20,8 @@ package com.puppycrawl.tools.checkstyle.checks.imports; /** * Represents the policy for checking import order statements. - * @see com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck * @author David DIDIER + * @see com.puppycrawl.tools.checkstyle.checks.imports.ImportOrderCheck */ public enum ImportOrderOption { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java index 776effc2d..7768c830f 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java @@ -580,8 +580,8 @@ public class JavadocMethodCheck extends AbstractTypeAwareCheck * Returns the tags in a javadoc comment. Only finds throws, exception, * param, return and see tags. * - * @return the tags found * @param comment the Javadoc comment + * @return the tags found */ private List getMethodTags(TextBlock comment) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java index 7d307f41b..8801d16f7 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/sizes/MethodCountCheck.java @@ -108,8 +108,8 @@ public final class MethodCountCheck extends Check } /** - * @return the value of a scope counter * @param scope the scope counter to get the value of + * @return the value of a scope counter */ int value(Scope scope) { diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/doclets/TokenTypesDoclet.java b/src/main/java/com/puppycrawl/tools/checkstyle/doclets/TokenTypesDoclet.java index 4eb161b12..43894f37e 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/doclets/TokenTypesDoclet.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/doclets/TokenTypesDoclet.java @@ -50,11 +50,11 @@ public final class TokenTypesDoclet /** * The doclet's starter method. * @param root RootDoc given to the doclet + * @return true if the given RootDoc is processed. * @exception FileNotFoundException will be thrown if the doclet * will be unable to write to the specified file. * @exception UnsupportedEncodingException will be thrown if the doclet * will be unable to use UTF-8 encoding. - * @return true if the given RootDoc is processed. */ public static boolean start(RootDoc root) throws FileNotFoundException, UnsupportedEncodingException diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionCommentFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionCommentFilter.java index 27aab6a0a..47938abdf 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionCommentFilter.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionCommentFilter.java @@ -54,9 +54,9 @@ import org.apache.commons.beanutils.ConversionException; * since that module makes the suppression comments in the .java * files available sub rosa. *

- * @see FileContentsHolder * @author Mike McMahon * @author Rick Giles + * @see FileContentsHolder */ public class SuppressionCommentFilter extends AutomaticBean