diff --git a/src/testinputs/com/puppycrawl/tools/checkstyle/filters/InputSuppressWarningsFilter.java b/src/testinputs/com/puppycrawl/tools/checkstyle/filters/InputSuppressWarningsFilter.java index 5341f584a..a1e907459 100644 --- a/src/testinputs/com/puppycrawl/tools/checkstyle/filters/InputSuppressWarningsFilter.java +++ b/src/testinputs/com/puppycrawl/tools/checkstyle/filters/InputSuppressWarningsFilter.java @@ -6,7 +6,7 @@ package com.puppycrawl.tools.checkstyle.filters; /** * Test input for using comments to suppress errors. - * + * * @author Trevor Robinson **/ @SuppressWarnings("foo") // coverage: no following AST diff --git a/src/xdocs/config.xml b/src/xdocs/config.xml index 6e4d0a703..aff5a512a 100755 --- a/src/xdocs/config.xml +++ b/src/xdocs/config.xml @@ -1096,23 +1096,27 @@

SuppressWarningsFilter

-

Filter SuppressWarningsFilter uses annotations to suppress audit events

+

+ Filter SuppressWarningsFilter uses annotations to + suppress audit events. +

Rationale: Same as for SuppressionCommentFilter. In the contrary to it - here we do not used comments but the builtin syntax of - @SuppressWarnings. This can be perceived as more - elegant solution than using comments. Also this maybe - supported but various IDE. + here, comments are not used comments but the builtin syntax of + @SuppressWarnings. This can be perceived as a + more elegant solution than using comments. Also this approach + maybe supported by various IDE.

- Usage: This filter only works in conjunction withe a - SuppressWarningsHolder since that check find the - annotations in all *.java files and make them available for - the filter. Because of that a configuration that includes this - filter must also include SuppressWarningsHolder - as a child module of the TreeWalker. + Usage: This filter only works in conjunction with a + SuppressWarningsHolder, since that check finds + the annotations in the Java files and makes them available for + the filter. Because of that, a configuration that includes + this filter must also include + SuppressWarningsHolder as a child module of the + TreeWalker.

SuppressWarningsFilter Properties
diff --git a/src/xdocs/config_annotation.xml b/src/xdocs/config_annotation.xml index 0bfd5ffb8..ab2c81a2e 100644 --- a/src/xdocs/config_annotation.xml +++ b/src/xdocs/config_annotation.xml @@ -341,17 +341,15 @@

- Maintains a set of check suppressions from SuppressWarnings - annotations. It allows to prevent Stylecheck from reporting - errors from parts of code that were annotated with - SuppressWarnings and using name of the check to - be excluded. You can also define aliases for check names that - need to be suppressed. + Maintains a set of check suppressions from + @SuppressWarnings annotations. It allows to + prevent Checkstyle from reporting errors from parts of code + that were annotated with @SuppressWarnings and + using name of the check to be excluded. You can also define + aliases for check names that need to be suppressed.

- -