changeset 11523:86a76770a6b1

Comment tweaks.
author Bruno Haible <bruno@clisp.org>
date Wed, 29 Apr 2009 03:02:27 +0200
parents 9b743df451ea
children cc55cbaf629a
files ChangeLog lib/unicase.h lib/uninorm.h lib/unistr.h
diffstat 4 files changed, 14 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,11 @@
+2009-04-28  Bruno Haible  <bruno@clisp.org>
+
+	Comment tweaks.
+	* lib/unistr.h (u*_cmp2): Clarify what memcmp2 is.
+	* lib/uninorm.h (u*_normxfrm): Fix description of return value.
+	* lib/unicase.h (u*_casexfrm): Likewise.
+	Reported by Paolo Bonzini.
+
 2009-04-28  Bruno Haible  <bruno@clisp.org>
 
 	Fix a compilation error.
--- a/lib/unicase.h
+++ b/lib/unicase.h
@@ -174,9 +174,9 @@
 		    const char *s2, size_t n2,
 		    const char *iso639_language, uninorm_t nf, int *resultp);
 
-/* Convert the string S of length N to a string in locale encoding, in such a
-   way that comparing uN_casexfrm (S1) and uN_casexfrm (S2) with memcmp2() is
-   equivalent to comparing S1 and S2 with uN_casecoll().
+/* Convert the string S of length N to a NUL-terminated byte sequence, in such
+   a way that comparing uN_casexfrm (S1) and uN_casexfrm (S2) with the gnulib
+   function memcmp2() is equivalent to comparing S1 and S2 with uN_casecoll().
    NF must be either UNINORM_NFC, UNINORM_NFKC, or NULL for no normalization.  */
 extern char *
        u8_casexfrm (const uint8_t *s, size_t n, const char *iso639_language,
--- a/lib/uninorm.h
+++ b/lib/uninorm.h
@@ -164,8 +164,8 @@
 		    uninorm_t nf, int *resultp);
 
 
-/* Converts the string S of length N to a string in locale encoding, in such a
-   way that comparing uN_normxfrm (S1) and uN_normxfrm (S2) with uN_cmp2() is
+/* Converts the string S of length N to a NUL-terminated byte sequence, in such
+   a way that comparing uN_normxfrm (S1) and uN_normxfrm (S2) with uN_cmp2() is
    equivalent to comparing S1 and S2 with uN_normcoll().
    NF must be either UNINORM_NFC or UNINORM_NFKC.  */
 extern char *
--- a/lib/unistr.h
+++ b/lib/unistr.h
@@ -403,7 +403,7 @@
        u32_cmp (const uint32_t *s1, const uint32_t *s2, size_t n);
 
 /* Compare S1 and S2.  */
-/* Similar to memcmp2().  */
+/* Similar to the gnulib function memcmp2().  */
 extern int
        u8_cmp2 (const uint8_t *s1, size_t n1, const uint8_t *s2, size_t n2);
 extern int