Tweaking the documentation

This commit is contained in:
Oliver Burn 2013-06-17 21:39:30 +10:00
parent 73e30e7597
commit 25ba46b76e
3 changed files with 22 additions and 20 deletions

View File

@ -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

View File

@ -1096,23 +1096,27 @@
<subsection name="SuppressWarningsFilter">
<h4>SuppressWarningsFilter</h4>
<p>Filter <code>SuppressWarningsFilter</code> uses annotations to suppress audit events</p>
<p>
Filter <code>SuppressWarningsFilter</code> uses annotations to
suppress audit events.
</p>
<p>
Rationale: Same as for
<code>SuppressionCommentFilter</code>. In the contrary to it
here we do not used comments but the builtin syntax of
<code>@SuppressWarnings</code>. 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
<code>@SuppressWarnings</code>. This can be perceived as a
more elegant solution than using comments. Also this approach
maybe supported by various IDE.
</p>
<p>
Usage: This filter only works in conjunction withe a
<code>SuppressWarningsHolder</code> 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 <code>SuppressWarningsHolder</code>
as a child module of the <code>TreeWalker</code>.
Usage: This filter only works in conjunction with a
<code>SuppressWarningsHolder</code>, 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
<code>SuppressWarningsHolder</code> as a child module of the
<code>TreeWalker</code>.
</p>
<h5>SuppressWarningsFilter Properties</h5>

View File

@ -341,17 +341,15 @@
<section name="SuppressWarningsHolder">
<subsection name="Description">
<p>
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
<code>SuppressWarnings</code> 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
<code>@SuppressWarnings</code> annotations. It allows to
prevent Checkstyle from reporting errors from parts of code
that were annotated with <code>@SuppressWarnings</code> and
using name of the check to be excluded. You can also define
aliases for check names that need to be suppressed.
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>