From 085dd5f174caf0190c6ef07a9bfddbe0746426e1 Mon Sep 17 00:00:00 2001
From: Shrey Kumar Singh <shrey18266@iiitd.ac.in>
Date: Sun, 12 Apr 2020 16:37:34 +0530
Subject: [PATCH] Issue #7179: Update documentation of filters to reference
 targets of suppression

---
 .../filters/SeverityMatchFilter.java          |  3 ++
 .../filters/SuppressWarningsFilter.java       |  4 ++
 .../SuppressWithNearbyCommentFilter.java      |  4 ++
 .../SuppressWithPlainTextCommentFilter.java   |  4 ++
 .../filters/SuppressionCommentFilter.java     |  3 ++
 .../checkstyle/filters/SuppressionFilter.java |  3 ++
 .../filters/SuppressionSingleFilter.java      |  4 ++
 .../filters/SuppressionXpathFilter.java       |  3 ++
 .../filters/SuppressionXpathSingleFilter.java |  3 ++
 src/xdocs/config_filters.xml                  | 41 +++++++++++++++++++
 10 files changed, 72 insertions(+)

diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SeverityMatchFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SeverityMatchFilter.java
index 6fbe31c0340..52cb3c3ac7c 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SeverityMatchFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SeverityMatchFilter.java
@@ -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.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWarningsFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWarningsFilter.java
index 3649b716031..8c3f6a20284 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWarningsFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWarningsFilter.java
@@ -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>
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java
index 9a998e2b6d3..bb95ec3b828 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyCommentFilter.java
@@ -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.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithPlainTextCommentFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithPlainTextCommentFilter.java
index be34f748599..43bd354e785 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithPlainTextCommentFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithPlainTextCommentFilter.java
@@ -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
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 81d578ff474..fbfcc256f62 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionCommentFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionCommentFilter.java
@@ -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
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionFilter.java
index 1bd10703ce8..5e361342f84 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionFilter.java
@@ -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.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionSingleFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionSingleFilter.java
index 25b83d97dc8..9953a333074 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionSingleFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionSingleFilter.java
@@ -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
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathFilter.java
index 2cf1ba9a4fa..618e016626b 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathFilter.java
@@ -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.
diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilter.java b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilter.java
index 8e5f39225bc..25381494886 100644
--- a/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilter.java
+++ b/src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathSingleFilter.java
@@ -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
diff --git a/src/xdocs/config_filters.xml b/src/xdocs/config_filters.xml
index c4000269a19..58ef7e44a38 100644
--- a/src/xdocs/config_filters.xml
+++ b/src/xdocs/config_filters.xml
@@ -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>
@@ -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">
@@ -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>
@@ -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>
@@ -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">
@@ -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>
@@ -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
@@ -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>
@@ -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>