add doxygen docs for utf8.h

git-svn-id: file:///home/lennart/svn/public/pulseaudio/trunk@914 fefdeb5f-60dc-0310-8127-8f9354f1896f

1 files changed, 7 insertions, 0 deletions

diff --git a/src/polyp/utf8.h b/src/polyp/utf8.h
index 6d1e4a7d..e9a51533 100644
--- a/src/polyp/utf8.h
+++ b/src/polyp/utf8.h
@@ -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