[polypaudio-commits] r893 - /trunk/src/polyp/polypaudio.h

[svnmailer-noreply at 0pointer.de]

Author: ossman
Date: Wed May 17 13:10:59 2006
New Revision: 893

URL: http://0pointer.de/cgi-bin/viewcvs.cgi?rev=893&root=polypaudio&view=rev
Log:
Update documentation to contain the UTF-8 requirement.

Modified:
    trunk/src/polyp/polypaudio.h

Modified: trunk/src/polyp/polypaudio.h
URL: http://0pointer.de/cgi-bin/viewcvs.cgi/trunk/src/polyp/polypaudio.h?rev=893&root=polypaudio&r1=892&r2=893&view=diff
==============================================================================
--- trunk/src/polyp/polypaudio.h (original)
+++ trunk/src/polyp/polypaudio.h Wed May 17 13:10:59 2006
@@ -54,6 +54,11 @@
  * \li The complete but somewhat complicated to use asynchronous API
  * \li The simplified, easy to use, but limited synchronous API
  *
+ * All strings in Polypaudio are in the UTF-8 encoding, regardless of current
+ * locale. Some functions will filter invalid sequences from the string, some
+ * will simply fail. To ensure reliable behaviour, make sure everything you
+ * pass to the API is already in UTF-8.
+ 
  * \section simple_sec Simple API
  *
  * Use this if you develop your program in synchronous style and just