diff --git a/ChangeLog b/ChangeLog index 666628974..b76a12647 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,8 @@ +2006-03-11 Richard Frith-Macdonald + + * Headers/Additions/GNUstepBase/GSXML.h: clarify documentation of + xml entity escaping methods. + 2006-03-10 Richard Frith-Macdonald * Source/NSTimeZone.m: diff --git a/Headers/Additions/GNUstepBase/GSXML.h b/Headers/Additions/GNUstepBase/GSXML.h index 31ed6e423..fbe5de009 100644 --- a/Headers/Additions/GNUstepBase/GSXML.h +++ b/Headers/Additions/GNUstepBase/GSXML.h @@ -56,13 +56,25 @@ */ @interface NSString (GSXML) /** - * Convert XML special characters in the receiver (like '&' and '"') - * to their escaped equivalents, and return the escaped string. + * Deals with standard XML internal entities.
+ * Converts the five XML special characters in the receiver ('>', '<', + * '&', ''' and '"') to their escaped equivalents, and return + * the escaped string.
+ * Also converts non-ascii characters to the corresponding numeric + * entity escape sequences.
+ * You should perform any non-standard entity substitution you require + * after you have called this method. */ - (NSString*) stringByEscapingXML; /** - * Convert XML escape sequences (like '&'amp; and '&quot;') - * to their unescaped equivalents, and return the unescaped string. + * Deals with standard XML internal entities.
+ * Converts the five XML escape sequences ('&gt;', '&lt;', '&amp;', + * '&apos;' and '&quot;') to the unicode characters they represent, + * and returns the unescaped string.
+ * Also converts numeric entity escape sequences to the corresponding unicode + * characters.
+ * You should perform any non-standard entity substitution you require + * before you have called this method. */ - (NSString*) stringByUnescapingXML; @end diff --git a/Source/Additions/GSXML.m b/Source/Additions/GSXML.m index 555e3b0ad..bba5ee849 100644 --- a/Source/Additions/GSXML.m +++ b/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 &lt;, + * escaped character information (the standard five entities &lt;, * &gt;, &apos;, &quot;, and &amp;) which are normally * replaced with their standard equivalents * (<, >, ', ", and &).