Document limitations of this function. (#487909, Peter Moulder)

2008-01-27  Matthias Clasen  <mclasen@redhat.com>

        * glib/gutf8.c (g_utf8_strreverse): Document limitations
        of this function.  (#487909, Peter Moulder)

svn path=/trunk/; revision=6391

diff --git a/ChangeLog b/ChangeLog
index 6e0165c..439bf19 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,6 +1,11 @@
 2008-01-27  Matthias Clasen  <mclasen@redhat.com>
 
-       * glib/goption.c: (group_list_has_visible_entries):
+       * glib/gutf8.c (g_utf8_strreverse): Document limitations
+       of this function.  (#487909, Peter Moulder)
+
+2008-01-27  Matthias Clasen  <mclasen@redhat.com>
+
+       * glib/goption.c (group_list_has_visible_entries):
        Removed unused variable is_main_group.  (#512381,
        Wouter Bolsterlee)
 

diff --git a/glib/gutf8.c b/glib/gutf8.c
index c8f6401..2676c41 100644 (file)
--- a/glib/gutf8.c
+++ b/glib/gutf8.c
@@ -1773,6 +1773,12 @@ g_unichar_validate (gunichar ch)
  * (Use g_utf8_validate() on all text before trying to use UTF-8 
  * utility functions with it.)
  *
+ * This function is intended for programmatic uses of reversed strings.
+ * It pays no attention to decomposed characters, combining marks, byte 
+ * order marks, directional indicators (LRM, LRO, etc) and similar 
+ * characters which might need special handling when reversing a string 
+ * for display purposes.
+ *
  * Note that unlike g_strreverse(), this function returns
  * newly-allocated memory, which should be freed with g_free() when
  * no longer needed.