Added the documentation missing in the patch.

This commit is contained in:
Oliver Burn 2011-01-01 12:13:43 +11:00
parent 5646a5ebba
commit 76b3486c0a
2 changed files with 25 additions and 0 deletions

View File

@ -232,6 +232,8 @@ public class MySingleton
<p>
Checks that any combination of String literals with optional
assignment is on the left side of an <code>equals()</code> comparison.
The check also processes <code>String.equalsIgnoreCase()</code>
invocations (which can be suppressed).
</p>
<p>
@ -292,6 +294,23 @@ number.equals(i + j);
</p>
</subsection>
<subsection name="Properties">
<table>
<tr>
<th>name</th>
<th>description</th>
<th>type</th>
<th>default value</th>
</tr>
<tr>
<td>ignoreEqualsIgnoreCase</td>
<td>whether to ignore <code>String.equalsIgnoreCase()</code> invocations</td>
<td><a href="property_types.html#boolean">boolean</a></td>
<td>false</td>
</tr>
</table>
</subsection>
<subsection name="Example">
<p>
To configure the check:

View File

@ -18,6 +18,12 @@
to support ignoring numbers in annotation declarations. Thanks to
Julio Cesar Cabral for patch #3132984.
</li>
<li>
Enhanced
<a href="config_coding.html#EqualsAvoidNull">EqualsAvoidNull</a>
to process <code>String.equalsIgnoreCase()</code>
invocations (which can be suppressed).
</li>
</ul>
<p>Bug fixes:</p>
<ul>