[polypaudio-commits] r914 - /trunk/src/polyp/utf8.h

[svnmailer-noreply at 0pointer.de]

Author: lennart
Date: Wed May 17 21:07:53 2006
New Revision: 914

URL: http://0pointer.de/cgi-bin/viewcvs.cgi?rev=914&root=polypaudio&view=rev
Log:
add doxygen docs for utf8.h

Modified:
    trunk/src/polyp/utf8.h

Modified: trunk/src/polyp/utf8.h
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/src/polyp/utf8.h?rev=914&root=polypaudio&r1=913&r2=914&view=diff
==============================================================================
--- trunk/src/polyp/utf8.h (original)
+++ trunk/src/polyp/utf8.h Wed May 17 21:07:53 2006
@@ -22,7 +22,14 @@
   USA.
 ***/
 
+/** \file
+ * UTF8 Validation functions
+ */
+
+/** Test if the specified strings qualifies as valid UTF8. Return the string if so, otherwise NULL */
 const char *pa_utf8_valid(const char *str);
+
+/** Filter all invalid UTF8 characters from the specified string, returning a new fully UTF8 valid string. Don't forget to free the returned string with pa_xfree() */
 char *pa_utf8_filter(const char *str);
 
 #endif