Added documentation for new parameters
requirePackageHtml, methodPattern, localVarPattern, allowPackage
This commit is contained in:
Lars Kühne
parent
c617457933
commit
aeacc039ed
|
|
@ -50,6 +50,12 @@ This task is included in the checkstyle distribution.</p>
|
|||
<td valign="top">Indicates whether to allow protected data. Defaults to <span class="default">"false"</span>.</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">allowPackage</td>
|
||||
<td valign="top">Indicates whether to allow package visible data. Defaults to <span class="default">"false"</span>.</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<tr>
|
||||
<td valign="top">allowNoAuthor</td>
|
||||
<td valign="top">Indicates whether to allow no <span class="default">@author</span> tag to be defined for class and interface Javadoc comments. Defaults to <span class="default">"false"</span>.</td>
|
||||
|
|
@ -112,6 +118,16 @@ This task is included in the checkstyle distribution.</p>
|
|||
<td valign="top">Specifies the regular expression to match against type names. Default value is defined <a href="engine.html#typeformat">here</a>.</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">methodPattern</td>
|
||||
<td valign="top">Specifies the regular expression to match against method names. Default value is defined <a href="engine.html#methodformat">here</a>.</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">localVarPattern</td>
|
||||
<td valign="top">Specifies the regular expression to match against local variable names. Default value is defined <a href="engine.html#localvarformat">here</a>.</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">headerFile</td>
|
||||
<td valign="top">Specifies the file containing the header lines. Default is to not check.</td>
|
||||
|
|
@ -127,6 +143,11 @@ This task is included in the checkstyle distribution.</p>
|
|||
<td valign="top">Specifies the visibility scope where javadoc comments are checked. Valid values are <span class="default">"nothing"</span>, <span class="default">"public"</span>, <span class="default">"protected"</span>, <span class="default">"package"</span>, <span class="default">"private"</span> and <span class="default">"anoninner"</span>. Defaults to <span class="default">"private"</span>.</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">requirePackageHtml</td>
|
||||
<td valign="top">Specifies whether to require that package documentation is available. Defaults to <span class="default">"false"</span>.</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">ignoreImports</td>
|
||||
<td valign="top">Specifies whether to ignore checking import statements. Defaults to <span class="default">"false"</span>.</td>
|
||||
|
|
|
|||
|
|
@ -53,6 +53,10 @@ This command line tool is included in the checkstyle distribution.</p>
|
|||
<tr>
|
||||
<td valign="top">checkstyle.allow.protected</td>
|
||||
<td valign="top">Indicates whether to allow protected data. Defaults to <span class="default">"no"</span>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">checkstyle.allow.package</td>
|
||||
<td valign="top">Indicates whether to allow package visible data. Defaults to <span class="default">"no"</span>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">checkstyle.allow.noauthor</td>
|
||||
|
|
@ -102,6 +106,14 @@ This command line tool is included in the checkstyle distribution.</p>
|
|||
<td valign="top">checkstyle.pattern.type</td>
|
||||
<td valign="top">Specifies the regular expression to match against type names. Default value is defined <a href="engine.html#typeformat">here</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">checkstyle.pattern.method</td>
|
||||
<td valign="top">Specifies the regular expression to match against method names. Default value is defined <a href="engine.html#methodformat">here</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">checkstyle.pattern.localvar</td>
|
||||
<td valign="top">Specifies the regular expression to match against local variable names. Default value is defined <a href="engine.html#localvarformat">here</a>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">checkstyle.header.file</td>
|
||||
<td valign="top">Specifies the file containing the header lines. Default is to not check.</td>
|
||||
|
|
@ -114,6 +126,11 @@ This command line tool is included in the checkstyle distribution.</p>
|
|||
<td valign="top">checkstyle.javadoc.scope</td>
|
||||
<td valign="top">Specifies the visibility scope where javadoc comments are checked. Valid values are <span class="default">"nothing"</span>, <span class="default">"public"</span>, <span class="default">"protected"</span>, <span class="default">"package"</span>, <span class="default">"private"</span> and <span class="default">"anoninner"</span>. Defaults to <span class="default">"private"</span>.</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">checkstyle.require.packagehtml</td>
|
||||
<td valign="top">Specifies whether to require that package documentation is available. Defaults to <span class="default">"false"</span>.</td>
|
||||
<td align="center" valign="top">No</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top">checkstyle.ignore.imports</td>
|
||||
<td valign="top">Specifies whether to ignore checking import statements. Defaults to <span class="default">"no"</span>.</td>
|
||||
|
|
|
|||
|
|
@ -53,6 +53,8 @@
|
|||
<li>method</li>
|
||||
</ul>
|
||||
|
||||
<p>You can require that a <span class="code">package.html</span> file exists for each package. This check is turned off by default.</p>
|
||||
|
||||
<p>Javadoc comments for class and interface declarations are checked to ensure that the <span class="code">@author</span> tag exists. This can be turned off.</p>
|
||||
|
||||
<p>You can control the visibility scope where Javadoc comments are checked. For example, you can check Javadoc code only for <span class="code">public</span> and <span class="code">protected</span> variables, methods, interfaces and class definitions. Scoping rules apply, in the above example a public method in a package visible class is not checked. You can also completely turn off all checking for Javadoc comments.</p>
|
||||
|
|
@ -164,10 +166,18 @@
|
|||
<p>Verifies that the format of public member names conform to a specified regular expression. The default is <span class="code">^f[A-Z][a-zA-Z0-9]*$</span>. This is useful for the fields required for Container Managed Persistence (CMP) Enterprise JavaBeans 1.1.</p>
|
||||
|
||||
|
||||
<h3><a name="methodformat">Format of method names</a></h3>
|
||||
<p>Verifies that the format of method names conform to a specified regular expression. The default is <span class="code">^[a-z][a-zA-Z0-9]*$</span>.</p>
|
||||
|
||||
|
||||
<h3><a name="localvarformat">Format of local variable names</a></h3>
|
||||
<p>Verifies that the format of local variables conform to a specified regular expression. The default is <span class="code">^[a-z][a-zA-Z0-9]*$</span>.</p>
|
||||
|
||||
|
||||
<h3>Visibility Modifiers</h3>
|
||||
<p>Checks for data members that are not declared <code>private</code>. Also finds <code>static</code> non-<code>final</code> data members that are not declared as <code>private</code>.</p>
|
||||
|
||||
<p>Note: you can turn on allowing <code>protected</code> data members.</p>
|
||||
<p>Note: you can turn on allowing <code>protected</code> or package visible data members.</p>
|
||||
|
||||
<div class="tip">
|
||||
<h4 class="tip">Tip</h4>
|
||||
|
|
|
|||
Loading…
Reference in New Issue