Clarify documentation a little

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@22636 72102866-910b-0410-8b05-ffd578937521

ChangeLog

@@ -1,3 +1,8 @@
+2006-03-11  Richard Frith-Macdonald <rfm@gnu.org>
+
+	* Headers/Additions/GNUstepBase/GSXML.h: clarify documentation of
+	xml entity escaping methods.
+
 2006-03-10  Richard Frith-Macdonald <rfm@gnu.org>
 
 	* Source/NSTimeZone.m:

Headers/Additions/GNUstepBase/GSXML.h

@@ -56,13 +56,25 @@
  */
 @interface	NSString (GSXML)
 /**
- * Convert XML special characters in the receiver (like '&' and '"')
+ * Deals with standard XML internal entities.<br />
- * to their escaped equivalents, and return the escaped string.
+ * Converts the five XML special characters in the receiver ('&gt;', '&lt;',
+ * '&amp;', '&apos;' and '&quot;') to their escaped equivalents, and return
+ * the escaped string.<br />
+ * Also converts non-ascii characters to the corresponding numeric
+ * entity escape sequences.<br />
+ * You should perform any non-standard entity substitution you require
+ * <em>after</em> you have called this method.
  */
 - (NSString*) stringByEscapingXML;
 /**
- * Convert XML escape sequences (like '&amp;'amp; and '&amp;quot;')
+ * Deals with standard XML internal entities.<br />
- * to their unescaped equivalents, and return the unescaped string.
+ * Converts the five XML escape sequences ('&amp;gt;', '&amp;lt;', '&amp;amp;',
+ * '&amp;apos;' and '&amp;quot;') to the unicode characters they represent,
+ * and returns the unescaped string.<br />
+ * Also converts numeric entity escape sequences to the corresponding unicode
+ * characters.<br />
+ * You should perform any non-standard entity substitution you require
+ * <em>before</em> you have called this method.
  */
 - (NSString*) stringByUnescapingXML;
 @end

Source/Additions/GSXML.m

@@ -987,7 +987,7 @@ static NSMapTable	*nodeNames = 0;
 
 /**
  * This performs the same function as the -content method, but retains
- * escaped character information (like the standard five entities <,
+ * escaped character information (the standard five entities <,
  * >, ', ", and &) which are normally
  * replaced with their standard equivalents
  * (<, >, ', ", and &).