Applying patch 848483 (Documentation fixes) from Ville Skytta (scop)

This commit is contained in:
Oleg Sukhodolsky 2003-11-25 09:56:43 +00:00
parent e57fd63469
commit d4fe5e2ce1
5 changed files with 8 additions and 28 deletions

View File

@ -1082,29 +1082,6 @@ return !valid();
<a href="config.html#treewalker">TreeWalker</a>
</p>
<!-- --> <a name="SuperClone"></a> <h2>SuperClone</h2> <h4>Description</h4>
<p class="body">
Checks that an overriding <span class="code">clone()</span> method invokes <span class="code">super.clone()</span>.
</p>
<p class="body">
Reference: <a href="http://java.sun.com/j2se/1.4.1/docs/api/java/lang/Object.html#clone()">Object.clone()</a>.
</p>
<h4>Examples</h4>
<p class="body">
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;SuperClone&quot;/&gt;
</pre>
<h4>Package</h4>
<p class="body">
com.puppycrawl.tools.checkstyle.checks.coding
</p>
<h4>Parent Module</h4>
<p class="body">
<a href="config.html#treewalker">TreeWalker</a>
</p>
<!-- --> <a name="IllegalCatch"></a> <h2>IllegalCatch</h2> <h4>Description</h4>
<p class="body">
Catching java.lang.Exception, java.lang.Error or java.lang.RuntimeException
@ -1389,7 +1366,7 @@ return !valid();
class="code">null</span> for object references, zero for numeric
types and <span class="code">char</span> and <span
class="code">false</span> for <span
class="code">booolean</span>.</p>
class="code">boolean</span>.</p>
<p class="body">Rationale: each instance variable gets
initialized twice, to the same value. Java
initializes each instance variable to its default

View File

@ -270,7 +270,7 @@
&lt;module name=&quot;ImportOrder&quot;>
&lt;property name=&quot;groups&quot; value=&quot;java,javax&quot;/>
&lt;property name=&quot;ordered&quot; value=&quot;true&quot;/>
&lt;preperty name=&quot;separated&quot; value=&quot;true&quot;/>
&lt;property name=&quot;separated&quot; value=&quot;true&quot;/>
&lt;/module>
</pre>
<h4>Package</h4>

View File

@ -174,7 +174,7 @@
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;UnusedParameter&quot;/&gt;
&lt;module name=&quot;usage.UnusedParameter&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore parameters whose name ends in <span class="code">Temp</span>:
@ -229,7 +229,7 @@
To configure the check:
</p>
<pre class="body">
&lt;module name=&quot;UnusedPrivateField&quot;/&gt;
&lt;module name=&quot;usage.UnusedPrivateField&quot;/&gt;
</pre>
<p class="body">
To configure the check to ignore fields whose name ends in <span class="code">Temp</span>:

View File

@ -97,6 +97,9 @@
and variable/method name are placed on different lines
(bug 848750).</li>
<li class="body">Fixed several typos in documentation (patch 848483
from Ville Skytta (scop)).</li>
</ul>
<a name="release3_2"></a>

View File

@ -30,7 +30,7 @@ import com.puppycrawl.tools.checkstyle.checks.CheckUtils;
* Checks if any class or object member explicitly initialized
* to default for its type value (<code>null</code> for object
* references, zero for numeric types and <code>char</code>
* and <code>false</code> for <code>booolean</code>.
* and <code>false</code> for <code>boolean</code>.
* </p>
* <p>
* Rationale: each instance variable gets