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

corrected usage checks documentation (bug 790457)

This commit is contained in:
Rick Giles 2003-08-29 15:05:02 +00:00
parent 9bc9f41827
commit 6b1ad4f2d6
3 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/config_usage.html
View File

@ -72,13 +72,13 @@
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;OneMethodPrivateField&quot;/&gt;
&lt;module name=&quot;usage.OneMethodPrivateField&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore fields whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;OneMethodPrivateField&quot;&gt;
&lt;module name=&quot;usage.OneMethodPrivateField&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
@ -120,13 +120,13 @@
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;UnusedLocalVariable&quot;/&gt;
&lt;module name=&quot;usage.UnusedLocalVariable&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore variables whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;UnusedLocalVariable&quot;&gt;
&lt;module name=&quot;usage.UnusedLocalVariable&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
@ -180,7 +180,7 @@
To configure the check to ignore parameters whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;UnusedParameter&quot;&gt;
&lt;module name=&quot;usage.UnusedParameter&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
@ -188,7 +188,7 @@
To configure the check to report unused <span class="code">catch</span> parameters:
</p>
<pre class="body">
&lt;module name=&quot;UnusedParameter&quot;&gt;
&lt;module name=&quot;usage.UnusedParameter&quot;&gt;
&lt;property name=&quot;ignoreCatch&quot; value=&quot;false&quot;/&gt;
&lt;/module&gt;
</pre>
@ -235,7 +235,7 @@
To configure the check to ignore fields whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;UnusedPrivateField&quot;&gt;
&lt;module name=&quot;usage.UnusedPrivateField&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>
@ -277,13 +277,13 @@
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;UnusedPrivateMethod&quot;/&gt;
&lt;module name=&quot;usage.UnusedPrivateMethod&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore methods whose name ends in <span class="code">Temp</span>:
</p>
<pre class="body">
&lt;module name=&quot;UnusedPrivateMethod&quot;&gt;
&lt;module name=&quot;usage.UnusedPrivateMethod&quot;&gt;
&lt;property name=&quot;ignoreFormat&quot; value=&quot;Temp$&quot;/&gt;
&lt;/module&gt;
</pre>

2
docs/releasenotes.html
View File

@ -217,6 +217,8 @@
and RemoteHomeInterfaceCheck (bug 791591)</li>
<li class="body">Fixed NoSuchMethodError when line wrapped at dot operator (bugid 790209)</li>
<li class="body">Incorrect usage checks documentation (bug 790457)</li>
</ul>

2
src/checkstyle/com/puppycrawl/tools/checkstyle/checks/usage/UnusedPrivateMethodCheck.java
View File

@ -30,7 +30,7 @@ import com.puppycrawl.tools.checkstyle.api.TokenTypes;
* An example of how to configure the check is:
* </p>
* <pre>
* &lt;module name="UnusedPrivateMethod"/&gt;
* &lt;module name="usage.UnusedPrivateMethod"/&gt;
* </pre>
* <p>
* @author Rick Giles