From 76ca3f317f4af91d76c868fef5ce5e6c0d45cb0c Mon Sep 17 00:00:00 2001
From: Stephen Colebourne <scolebourne@apache.org>
Date: Sat, 13 May 2006 12:11:13 +0000
Subject: [PATCH] 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
---
 .../apache/commons/lang/StringEscapeUtils.java   | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/src/java/org/apache/commons/lang/StringEscapeUtils.java b/src/java/org/apache/commons/lang/StringEscapeUtils.java
index 8e4a8c5cd..d8fe391ba 100644
--- a/src/java/org/apache/commons/lang/StringEscapeUtils.java
+++ b/src/java/org/apache/commons/lang/StringEscapeUtils.java
@@ -425,8 +425,10 @@ public class StringEscapeUtils {
      * <code>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</code>.
      * </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
      * @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>
      * <p>becomes:</p>
      * <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 
-     * the common apostrophe escape character (&amp;apos; is not a legal entity 
-     * and so is not supported. </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 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>.
      *