Skip to content

Commit

Permalink
Issue checkstyle#7179: Update documentation of filters to reference t…
Browse files Browse the repository at this point in the history
…argets of suppression
  • Loading branch information
sulkykookie authored and rnveach committed Apr 15, 2020
1 parent 14e4b54 commit 085dd5f
Show file tree
Hide file tree
Showing 10 changed files with 72 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
* Filter {@code SeverityMatchFilter} decides audit events according to the
* <a href="https://checkstyle.org/config.html#Severity">severity level</a> of the event.
* </p>
* <p>
* SeverityMatchFilter can suppress Checks that have Treewalker or Checker as parent module.
* </p>
* <ul>
* <li>
* Property {@code severity} - Specify the severity level of this filter.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,10 @@
* any dotted prefix or "Check" suffix removed.
* </p>
* <p>
* SuppressWarningsFilter can suppress Checks that have Treewalker or
* Checker as parent module.
* </p>
* <p>
* To configure the check that makes tha annotations available to the filter.
* </p>
* <pre>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,10 @@
* a <a href="https://checkstyle.org/config_filters.html#SuppressWithPlainTextCommentFilter">
* SuppressWithPlainTextCommentFilter</a> or similar filter must be used.
* </p>
* <p>
* SuppressWithNearbyCommentFilter can suppress Checks that have
* Treewalker as parent module.
* </p>
* <ul>
* <li>
* Property {@code commentFormat} - Specify comment pattern to trigger filter to begin suppression.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,10 @@
* <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Matcher.html#groupCount()">
* paren counts</a>.
* </p>
* <p>
* SuppressionWithPlainTextCommentFilter can suppress Checks that have Treewalker or
* Checker as parent module.
* </p>
* <ul>
* <li>
* Property {@code offCommentFormat} - Specify comment pattern to trigger filter
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@
* <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Matcher.html#groupCount()">
* paren counts</a>.
* </p>
* <p>
* SuppressionCommentFilter can suppress Checks that have Treewalker as parent module.
* </p>
* <ul>
* <li>
* Property {@code offCommentFormat} - Specify comment pattern to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@
* if no file found, then passed to the {@code ClassLoader.getResource()} method.
* </li>
* </ol>
* <p>
* SuppressionFilter can suppress Checks that have Treewalker or Checker as parent module.
* </p>
* <ul>
* <li>
* Property {@code file} - Specify the location of the <em>suppressions XML document</em> file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,10 @@
* Attention: This filter only supports single suppression, and will need multiple instances if
* users wants to suppress multiple violations.
* </p>
* <p>
* SuppressionSingleFilter can suppress Checks that have Treewalker or
* Checker as parent module.
* </p>
* <ul>
* <li>
* Property {@code files} - Define the RegExp for matching against the file name associated with
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,9 @@
* if no file found, then passed to the {@code ClassLoader.getResource()} method.
* </li>
* </ol>
* <p>
* SuppressionXpathFilter can suppress Checks that have Treewalker as parent module.
* </p>
* <ul>
* <li>
* Property {@code file} - Specify the location of the <em>suppressions XML document</em> file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,9 @@
* Attention: This filter only supports single suppression, and will need multiple
* instances if users wants to suppress multiple violations.
* </p>
* <p>
* SuppressionXpathSingleFilter can suppress Checks that have Treewalker as parent module.
* </p>
* <ul>
* <li>
* Property {@code files} - Define a Regular Expression matched against the file
Expand Down
41 changes: 41 additions & 0 deletions src/xdocs/config_filters.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,11 @@
level</a> of the event.
</p>
</subsection>
<subsection name="Notes" id="SeverityMatchFilter_Notes">
<p>
SeverityMatchFilter can suppress Checks that have Treewalker or Checker as parent module.
</p>
</subsection>
<subsection name="Properties" id="SeverityMatchFilter_Properties">
<div class="wrapper">
<table>
Expand Down Expand Up @@ -130,6 +135,9 @@
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Matcher.html#groupCount()">
paren counts</a>.
</p>
<p>
SuppressionCommentFilter can suppress Checks that have Treewalker as parent module.
</p>
</subsection>
<subsection name="Properties" id="SuppressionCommentFilter_Properties">
<div class="wrapper">
Expand Down Expand Up @@ -551,6 +559,9 @@ public class UserService {
<code>ClassLoader.getResource()</code> method.
</li>
</ol>
<p>
SuppressionFilter can suppress Checks that have Treewalker or Checker as parent module.
</p>
</subsection>
<subsection name="Examples" id="SuppressionFilter_Examples">
<p>
Expand Down Expand Up @@ -700,6 +711,12 @@ public class UserService {
multiple instances if users wants to suppress multiple violations.
</p>
</subsection>
<subsection name="Notes" id="SuppressionSingleFilter_Notes">
<p>
SuppressionSingleFilter can suppress Checks that have Treewalker or
Checker as parent module.
</p>
</subsection>
<subsection name="Properties" id="SuppressionSingleFilter_Properties">
<div class="wrapper">
<table>
Expand Down Expand Up @@ -985,6 +1002,9 @@ public class UserService {
<code>ClassLoader.getResource()</code> method.
</li>
</ol>
<p>
SuppressionXpathFilter can suppress Checks that have Treewalker as parent module.
</p>
</subsection>
<subsection name="Properties" id="SuppressionXpathFilter_Properties">
<div class="wrapper">
Expand Down Expand Up @@ -1385,6 +1405,11 @@ CLASS_DEF -> CLASS_DEF [1:0]
multiple instances if users wants to suppress multiple violations.
</p>
</subsection>
<subsection name="Notes" id="SuppressionXpathSingleFilter_Notes">
<p>
SuppressionXpathSingleFilter can suppress Checks that have Treewalker as parent module.
</p>
</subsection>
<subsection name="Properties" id="SuppressionXpathSingleFilter_Properties">
<div class="wrapper">
<table>
Expand Down Expand Up @@ -1845,6 +1870,12 @@ public class TestClass {
and should be written with any dotted prefix or "Check" suffix removed.
</p>
</subsection>
<subsection name="Notes" id="SuppressWarningsFilter_Notes">
<p>
SuppressWarningsFilter can suppress Checks that have Treewalker or
Checker as parent module.
</p>
</subsection>
<subsection name="Examples" id="SuppressWarningsFilter_Examples">
<p>
To configure the check that makes tha annotations available to
Expand Down Expand Up @@ -1951,6 +1982,12 @@ public static void foo() {
SuppressWithPlainTextCommentFilter</a> or similar filter must be used.
</p>
</subsection>
<subsection name="Notes" id="SuppressWithNearbyCommentFilter_Notes">
<p>
SuppressWithNearbyCommentFilter can suppress Checks that have
Treewalker as parent module.
</p>
</subsection>
<subsection name="Properties" id="SuppressWithNearbyCommentFilter_Properties">
<div class="wrapper">
<table>
Expand Down Expand Up @@ -2281,6 +2318,10 @@ public class UserService {
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/regex/Matcher.html#groupCount()">
paren counts</a>.
</p>
<p>
SuppressionWithPlainTextCommentFilter can suppress Checks that have Treewalker or
Checker as parent module.
</p>
</subsection>
<subsection name="Examples" id="SuppressWithPlainTextCommentFilter_Examples">
<p>
Expand Down

0 comments on commit 085dd5f

Please sign in to comment.