Javadoc for not escaping apos

git-svn-id: https://svn.apache.org/repos/asf/jakarta/commons/proper/lang/trunk@406082 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Stephen Colebourne 2006-05-13 12:11:13 +00:00
parent 2bdf879815
commit 76ca3f317f
1 changed files with 9 additions and 7 deletions

View File

@ -425,8 +425,10 @@ public class StringEscapeUtils {
* <code>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</code>. * <code>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</code>.
* </p> * </p>
* *
* <p>Supports all known HTML 4.0 entities, including funky accents.</p> * <p>Supports all known HTML 4.0 entities, including funky accents.
* * Note that the commonly used apostrophe escape character (&amp;apos;)
* is not a legal entity and so is not supported). </p>
*
* @param str the <code>String</code> to escape, may be null * @param str the <code>String</code> to escape, may be null
* @return a new escaped <code>String</code>, <code>null</code> if null string input * @return a new escaped <code>String</code>, <code>null</code> if null string input
* *
@ -464,11 +466,11 @@ public class StringEscapeUtils {
* <code>"bread" & "butter"</code> * <code>"bread" & "butter"</code>
* <p>becomes:</p> * <p>becomes:</p>
* <code>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</code>. * <code>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</code>.
* *
* <p>Supports all known HTML 4.0 entities, including funky accents. Note that * <p>Supports all known HTML 4.0 entities, including funky accents.
* the common apostrophe escape character (&amp;apos; is not a legal entity * Note that the commonly used apostrophe escape character (&amp;apos;)
* and so is not supported. </p> * is not a legal entity and so is not supported). </p>
* *
* @param writer The <code>Writer</code> to write the result to. This must not be <code>null</code>. * @param writer The <code>Writer</code> to write the result to. This must not be <code>null</code>.
* @param string The <code>String</code> to escape. This may be <code>null</code>. * @param string The <code>String</code> to escape. This may be <code>null</code>.
* *