TouchInstinct
/
checkstyle
306
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated documentation for the new checks on method and constructor lengths

This commit is contained in:
Oliver Burn 2002-01-06 06:29:19 +00:00
parent efcb63fd74
commit a3d490b41f
3 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/anttask.html
View File

@ -67,6 +67,16 @@ This task is included in the checkstyle distribution.</p>
<td valign="top">Specifies whether to ignore the maximum line length for <span class="code">import</span> statements. Defaults to <span class="default">&quot;false&quot;</span>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">maxMethodLen</td>
<td valign="top">Specifies the maximum method length. Default value is defined <a href="index.html#methodLength">here</a>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>
<td valign="top">maxConstructorLen</td>
<td valign="top">Specifies the maximum constructor length. Default value is defined <a href="index.html#constructorLength">here</a>.</td>
<td align="center" valign="top">No</td>
</tr>
<tr>

8
docs/cmdline.html
View File

@ -59,6 +59,14 @@ This command line tool is included in the checkstyle distribution.</p>
<td valign="top">checkstyle.ignore.importlength</td>
<td valign="top">Specifies whether to ignore the maximum line length for <span class="code">import</span> statements. Defaults to <span class="default">&quot;false&quot;</span>.</td>
</tr>
<tr>
<td valign="top">checkstyle.maxmethodlen</td>
<td valign="top">Specifies the maximum method length. Default value is defined <a href="index.html#methodLength">here</a>.</td>
</tr>
<tr>
<td valign="top">checkstyle.maxconstructorlen</td>
<td valign="top">Specifies the maximum constructor length. Default value is defined <a href="index.html#constructorLength">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="index.html#varformat">here</a>.</td>

7
docs/index.html
View File

@ -38,6 +38,7 @@ div.tip {margin-left : 5%;margin-right : 5%;padding-left: 2%; padding-right: 2%;
<li>Correct use of white space around binary and unary operators. For example, <span class="code">x -=- 1;</span> is illegal, whereas <span class="code">x -= -1;</span> is not. Note: these checks can be turned off.</li>
<li>Ensure <span class="code">{}</span>'s are used for <span class="code">if/while/for/do</span> constructs. Note: this check can be turned off.</li>
<li>Lines are not longer than a specified length.</li>
<li>Methods and constructors that are longer than a specified number of lines.</li>
<li>Lines do not contain tabs. Note: this check can be turned off.</li>
</ul>
@ -143,6 +144,12 @@ div.tip {margin-left : 5%;margin-right : 5%;padding-left: 2%; padding-right: 2%;
<h3><a name="length">Long Lines</a></h3>
<p>Checks for lines that are longer that a specified length. The default is <span class="default">&quot;80&quot;</span>. This can be turned off for <code>import</code> statements.</p>
<h3><a name="methodLength">Method Body Length</a></h3>
<p>Checks for method bodies that are longer that a specified number of lines. The default is <span class="default">&quot;150&quot;</span>.
<h3><a name="constructorLength">Constructor Body Length</a></h3>
<p>Checks for constructor bodies that are longer that a specified number of lines. The default is <span class="default">&quot;150&quot;</span>.
<h3>Tab characters</h3>
<p>Checks for lines that contain tab (<code>'\t'</code>) characters. This can be turned off.</p>