Request 582144: added documentation.

docs/anttask.html

@@ -150,6 +150,12 @@ This task is included in the checkstyle distribution.</p>
     <td align="center" valign="top">No</td>
   </tr>
 
+  <tr>
+    <td valign="top">maxParameters</td>
+    <td valign="top">Specifies the maximum number of parameters. Default value is defined <a href="engine.html#numParams">here</a>.</td>
+    <td align="center" valign="top">No</td>
+  </tr>
+
   <tr>
     <td valign="top">todoPattern</td>
     <td valign="top">Specifies the regular expression to match for to-do comments. Default value is defined <a href="engine.html#todo">here</a>.</td>

docs/cmdline.html

@@ -129,10 +129,17 @@ This command line tool is included in the checkstyle distribution.</p>
     <td valign="top">checkstyle.maxfilelen</td>
     <td valign="top">Specifies the maximum file length. Default value is defined <a href="engine.html#fileLength">here</a>.</td>
   </tr>
+
+  <tr>
+    <td valign="top">checkstyle.maxparameters</td>
+    <td valign="top">Specifies the maximum number of parameters. Default value is defined <a href="engine.html#numParams">here</a>.</td>
+  </tr>
+
   <tr>
     <td valign="top">checkstyle.pattern.todo</td>
     <td valign="top">Specifies the regular expression to match for to-do comments. Default value is defined <a href="engine.html#todo">here</a>.</td>
   </tr>
+
   <tr>
     <td valign="top">checkstyle.pattern.member</td>
     <td valign="top">Specifies the regular expression to match against member variables. Default value is defined <a href="engine.html#varformat">here</a>.</td>

docs/engine.html

@@ -205,6 +205,9 @@
 <h3>Tab characters</h3>
 <p>Checks for lines that contain tab (<code>'\t'</code>) characters. This can be turned off.</p>
 
+<h3><a name="numParams">Number of parameters</a></h3>
+<p>Checks for the number of parameters in a declaration being greater than a specified amount. The default is <span class="default">&quot;7&quot;</span>.</p>
+
 <h3><a name="todo">To-do comments</a></h3>
 <p>Checks for comments that contain a specified regular expression. The default is <span class="default">&quot;TODO:&quot;</span>.</p>
 

docs/releasenotes.html

@@ -42,6 +42,7 @@
       <p class="body">
         New features:
         <ul>
+          <li class="body">Detect the number of parameters in a declaration exceeding a specified amount (request 582144).</li>
           <li class="body">Inspired by patch 580410 from Shinya Ohnuma, now the error message are localised.</li>
           <li class="body">Support checking to determine if an unused <span class="code">@throws</span> exception is a subclass of <span class="code">java.lang.Error</span> (request 583719).</li>
           <li class="body">Incorporate patch 590931 from Vijay Aravamudhan to improve documentation of the build.xml file.</li>

src/checkstyle/com/puppycrawl/tools/checkstyle/AuditEvent.java

@@ -40,6 +40,7 @@ public class AuditEvent
 {
     /** filename event associated with **/
     private final String mFileName;
+    /** message associated with the event **/
     private final LocalizedMessage mMessage;
 
     /**
@@ -109,6 +110,7 @@ public class AuditEvent
         return mMessage.getColumnNo();
     }
 
+    /** @return the localized message **/
     public LocalizedMessage getLocalizedMessage()
     {
         return mMessage;

src/checkstyle/com/puppycrawl/tools/checkstyle/Verifier.java

@@ -257,7 +257,6 @@ class Verifier
         checkModOrder(aSig.getModSet());
 
         // Check for to many parameters
-        // TODO: Add documentation and a test
         if (aSig.getParams().size() > mConfig.getMaxParameters()) {
             log(aSig.getFirstLineNo(),
                 aSig.getFirstColNo(),