diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java index aff38edaa..50b8b1e66 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheck.java @@ -26,6 +26,8 @@ import java.util.Locale; import java.util.Set; import java.util.regex.Pattern; +import org.apache.commons.lang3.ArrayUtils; + import com.google.common.collect.ImmutableSortedSet; import com.puppycrawl.tools.checkstyle.api.Check; import com.puppycrawl.tools.checkstyle.api.DetailAST; @@ -117,22 +119,22 @@ public class JavadocStyleCheck @Override public int[] getAcceptableTokens() { return new int[] { - TokenTypes.INTERFACE_DEF, - TokenTypes.CLASS_DEF, TokenTypes.ANNOTATION_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.METHOD_DEF, - TokenTypes.CTOR_DEF, - TokenTypes.VARIABLE_DEF, - TokenTypes.ENUM_CONSTANT_DEF, TokenTypes.ANNOTATION_FIELD_DEF, + TokenTypes.CLASS_DEF, + TokenTypes.CTOR_DEF, + TokenTypes.ENUM_CONSTANT_DEF, + TokenTypes.ENUM_DEF, + TokenTypes.INTERFACE_DEF, + TokenTypes.METHOD_DEF, TokenTypes.PACKAGE_DEF, + TokenTypes.VARIABLE_DEF, }; } @Override public int[] getRequiredTokens() { - return getAcceptableTokens(); + return ArrayUtils.EMPTY_INT_ARRAY; } @Override diff --git a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java index d277d46c3..eda8d9cdd 100644 --- a/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java +++ b/src/test/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocStyleCheckTest.java @@ -45,41 +45,22 @@ public class JavadocStyleCheckTest + "javadoc" + File.separator + filename); } - @Test - public void testGetRequiredTokens() { - final JavadocStyleCheck javadocStyleCheck = new JavadocStyleCheck(); - final int[] actual = javadocStyleCheck.getRequiredTokens(); - final int[] expected = { - TokenTypes.INTERFACE_DEF, - TokenTypes.CLASS_DEF, - TokenTypes.ANNOTATION_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.METHOD_DEF, - TokenTypes.CTOR_DEF, - TokenTypes.VARIABLE_DEF, - TokenTypes.ENUM_CONSTANT_DEF, - TokenTypes.ANNOTATION_FIELD_DEF, - TokenTypes.PACKAGE_DEF, - }; - assertArrayEquals(expected, actual); - } - @Test public void testGetAcceptableTokens() { final JavadocStyleCheck javadocStyleCheck = new JavadocStyleCheck(); final int[] actual = javadocStyleCheck.getAcceptableTokens(); final int[] expected = { - TokenTypes.INTERFACE_DEF, - TokenTypes.CLASS_DEF, TokenTypes.ANNOTATION_DEF, - TokenTypes.ENUM_DEF, - TokenTypes.METHOD_DEF, - TokenTypes.CTOR_DEF, - TokenTypes.VARIABLE_DEF, - TokenTypes.ENUM_CONSTANT_DEF, TokenTypes.ANNOTATION_FIELD_DEF, + TokenTypes.CLASS_DEF, + TokenTypes.CTOR_DEF, + TokenTypes.ENUM_CONSTANT_DEF, + TokenTypes.ENUM_DEF, + TokenTypes.INTERFACE_DEF, + TokenTypes.METHOD_DEF, TokenTypes.PACKAGE_DEF, + TokenTypes.VARIABLE_DEF, }; assertArrayEquals(expected, actual); @@ -404,4 +385,20 @@ public class JavadocStyleCheckTest getPath("pkginfo" + File.separator + "valid" + File.separator + "package-info.java"), expected); } + + @Test + public void testRestrictedTokenSet() + throws Exception { + final DefaultConfiguration checkConfig = createCheckConfig(JavadocStyleCheck.class); + checkConfig.addAttribute("tokens", "METHOD_DEF"); + checkConfig.addAttribute("scope", "public"); + checkConfig.addAttribute("checkFirstSentence", "true"); + checkConfig.addAttribute("checkEmptyJavadoc", "false"); + checkConfig.addAttribute("checkHtml", "false"); + final String[] expected = { + "88: " + getCheckMessage(NO_PERIOD), + "386: " + getCheckMessage(NO_PERIOD), + }; + verify(checkConfig, getPath("InputJavadocStyle.java"), expected); + } } diff --git a/src/xdocs/config_javadoc.xml b/src/xdocs/config_javadoc.xml index e423ddb91..397585e56 100644 --- a/src/xdocs/config_javadoc.xml +++ b/src/xdocs/config_javadoc.xml @@ -686,6 +686,34 @@ public boolean isSomething() boolean true + + tokens + tokens to check + subset of tokens + ANNOTATION_DEF, + ANNOTATION_FIELD_DEF, + CLASS_DEF, + CTOR_DEF, + ENUM_CONSTANT_DEF, + ENUM_DEF, + INTERFACE_DEF, + METHOD_DEF, + PACKAGE_DEF, + VARIABLE_DEF. + + + ANNOTATION_DEF, + ANNOTATION_FIELD_DEF, + CLASS_DEF, + CTOR_DEF, + ENUM_CONSTANT_DEF, + ENUM_DEF, + INTERFACE_DEF, + METHOD_DEF, + PACKAGE_DEF, + VARIABLE_DEF. + +