added EmptyForIteratorPad docs
This commit is contained in:
parent
e24b549624
commit
9b585ff48b
|
|
@ -22,6 +22,9 @@
|
|||
<!--Left menu-->
|
||||
<td class="menu" valign="top">
|
||||
<ul>
|
||||
<li>
|
||||
<a href="#EmptyForIteratorPad">EmptyForIteratorPad</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="#NoWhitespaceAfter">NoWhitespaceAfter</a>
|
||||
</li>
|
||||
|
|
@ -46,7 +49,57 @@
|
|||
</ul>
|
||||
</td>
|
||||
<!--Content-->
|
||||
<td class="content" valign="top" align="left"><a name="NoWhitespaceAfter"></a> <h2>NoWhitespaceAfter</h2>
|
||||
<td class="content" valign="top" align="left">
|
||||
|
||||
<a name="EmptyForIteratorPad"></a> <h2>EmptyForIteratorPad</h2> <h4>Description</h4>
|
||||
|
||||
<p class="body">
|
||||
Checks the padding of an empty for iterator; that is whether white
|
||||
space is required at an empty for iterator, or such white space is
|
||||
forbidden.
|
||||
</p>
|
||||
<h4>Properties</h4>
|
||||
<table width="100%" border="1" cellpadding="5" class="body">
|
||||
<tr class="header">
|
||||
<th>name</th>
|
||||
<th>description</th>
|
||||
<th>type</th>
|
||||
<th>default value</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>option</td>
|
||||
<td>policy on how to pad an empty for iterator</td>
|
||||
<td><a href="property_types.html#parenPad">pad policy</a></td>
|
||||
<td><span class="default">nospace</span></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<h4>Examples</h4>
|
||||
<p class="body">
|
||||
To configure the check:
|
||||
</p>
|
||||
<pre class="body">
|
||||
<module name="EmptyForIteratorPad"/>
|
||||
</pre>
|
||||
<p class="body">
|
||||
To configure the check to require white space at an empty for iterator:
|
||||
</p>
|
||||
<pre class="body">
|
||||
<module name="EmptyForIteratorPad">
|
||||
<property name="option" value="space"/>
|
||||
</module>
|
||||
</pre>
|
||||
<h4>Package</h4>
|
||||
<p class="body">
|
||||
com.puppycrawl.tools.checkstyle.checks
|
||||
</p>
|
||||
|
||||
<h4>Parent Module</h4>
|
||||
<p class="body">
|
||||
<a href="config.html#treewalker">TreeWalker</a>
|
||||
</p>
|
||||
|
||||
<a name="NoWhitespaceAfter"></a> <h2>NoWhitespaceAfter</h2>
|
||||
<h4>Description</h4>
|
||||
|
||||
<p class="body">
|
||||
|
|
@ -392,7 +445,7 @@
|
|||
<tr>
|
||||
<td>option</td>
|
||||
<td>policy on how to pad parentheses</td>
|
||||
<td><a href="property_types.html#parenPad">pad parentheses policy</a></td>
|
||||
<td><a href="property_types.html#parenPad">pad policy</a></td>
|
||||
<td><span class="default">nospace</span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
|
|||
|
|
@ -62,12 +62,12 @@ parsed using the excellent <a href="http://jakarta.apache.org/regexp/">Jakarta
|
|||
Regexp</a> library.</p>
|
||||
|
||||
|
||||
<h2><a name="parenPad">Pad Parenthesis Policy</a></h2>
|
||||
<h2><a name="parenPad">Pad Policy</a></h2>
|
||||
|
||||
<p>This property represents the policy for padding parentheses. The
|
||||
<p>This property represents the policy for padding with white space. The
|
||||
following table describes the valid options:</p>
|
||||
|
||||
<table border="1" summary="parenthesises padding options">
|
||||
<table border="1" summary="padding options">
|
||||
<tr class="header">
|
||||
<td>Option</td>
|
||||
<td>Definition</td>
|
||||
|
|
|
|||
Loading…
Reference in New Issue