Issue #12228: Changes in the overview section applied

checkstyle · Oct 28, 2022 · 3bbdf40 · 3bbdf40
1 parent 0ad54c5
commit 3bbdf40
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 16 deletions.
diff --git a/src/xdocs/config.xml b/src/xdocs/config.xml
@@ -26,21 +26,21 @@
 
       <ul>
 
-        <li><em>FileSetChecks</em> - modules that take a set of input
+        <li><em>File Set Checks</em> - modules that take a set of input
         files and fire violation messages.</li>
 
         <li><em>Filters</em>
 
         - modules that filter audit events,
         including messages, for acceptance.</li>
 
-        <li><em>AuditListeners</em> - modules that report accepted events.</li>
+        <li><em>Audit Listeners</em> - modules that report accepted events.</li>
 
       </ul>
 
       <p>
         Many checks are submodules of the <em>TreeWalker</em>
-        FileSetCheck module. The TreeWalker operates by separately
+        File Set Check module. The TreeWalker operates by separately
         transforming each of the Java source files into an abstract
         syntax tree and then handing the result over to each of its
         submodules which in turn have a look at certain aspects of the
@@ -256,10 +256,8 @@
 
       <p>
         Apart from the above mentioned properties, there are a few system
-        properties that changes the way how Checkstyle behaves. For example,
-        if you want to change the language of the output of Checkstyle, it
-        can be done by changing the property checkstyle.locale.language. All
-        the system properties can be found at the
+        properties that changes the way how Checkstyle behaves.
+        All the system properties can be found at the
         <a href="config_system_properties.html">system properties</a> page.
       </p>
 
@@ -279,13 +277,13 @@
         </p>
 
         <ul>
-          <li><em>FileSetCheck</em> children: modules that check sets of
+          <li><em>File Set Check</em> children: modules that check sets of
           files.</li>
           <li><em>Filter</em> children: modules that filter audit
           events.</li>
-          <li><em>FileFilter</em> children: modules that filter files
+          <li><em>File Filter</em> children: modules that filter files
           for Checkstyle to process.</li>
-          <li><em>AuditListener</em> children: modules that report
+          <li><em>Audit Listener</em> children: modules that report
           filtered events.</li>
         </ul>
 
@@ -379,9 +377,10 @@
 
       <subsection name="Metadata" id="Checker_Metadata">
         <p>
-          Used to keep metadata in the Checkstyle configuration file. This
-          information is ignored by Checkstyle. This may be useful if you want to
-          store plug-in specific information or any other information in config file.
+          This tag is used to keep metadata in the Checkstyle configuration file.
+          This information is ignored by Checkstyle. This may be useful if you want
+          to store plug-in specific information or any other information in the config
+          file.
         </p>
         <p>
           To avoid name clashes between different tools/plug-ins you are <b>strongly</b>
@@ -509,7 +508,7 @@
       <subsection name="Description" id="TreeWalker_Description">
         <p>Since Checkstyle 3.0</p>
         <p>
-          FileSetCheck <code>TreeWalker</code> checks
+          File Set Check <code>TreeWalker</code> checks
           individual Java source files and defines properties that are
           applicable to checking such files.
         </p>
@@ -861,7 +860,7 @@
 
     </section>
 
-    <section name="AuditListeners">
+    <section name="Audit Listeners">
 
       <p>
         In addition to an audit reporter for text or XML output, a

diff --git a/src/xdocs/writinglisteners.xml.vm b/src/xdocs/writinglisteners.xml.vm
@@ -195,7 +195,7 @@ public class VerboseListener
         To incorporate a custom listener in the set of listeners for a
         <code>Checker</code>, include a module element for
         the listener in the <a
-        href="config.html#AuditListeners">configuration file</a>. For
+        href="config.html#Audit_Listeners">configuration file</a>. For
         example, to configure a <code>Checker</code> so
         that it uses custom listener
         <a href="https://github.com/checkstyle/contribution/blob/master/examples/listeners/com/mycompany/listeners/VerboseListener.java">