docs

2001-04-16  Havoc Pennington  <hp@redhat.com>

        * gqsort.c: docs

        * gfileutils.c: docs

        * gwin32.c: docs fixes

        * gconvert.c: docs

        * guniprop.c: docs

        * gutf8.c: docs

1 files changed, 13 insertions, 0 deletions

diff --git a/glib/gunibreak.c b/glib/gunibreak.c
index 6a4b83795..4f3295993 100644
--- a/glib/gunibreak.c
+++ b/glib/gunibreak.c
@@ -35,6 +35,19 @@
 
 #define PROP(Char) (((Char) > (G_UNICODE_LAST_CHAR)) ? G_UNICODE_UNASSIGNED : TPROP ((Char) >> 8, (Char) & 0xff))
 
+/**
+ * g_unichar_break_type:
+ * @c: a Unicode character
+ * 
+ * Determines the break type of @c. @c should be a Unicode character
+ * (to derive a character from UTF-8 encoded text, use
+ * g_utf8_get_char()). The break type is used to find word and line
+ * breaks ("text boundaries"), Pango implements the Unicode boundary
+ * resolution alogorithms and normally you would use a function such
+ * as pango_break() instead of caring about break types yourself.
+ * 
+ * Return value: break type
+ **/
 GUnicodeBreakType
 g_unichar_break_type (gunichar c)
 {