diff src/util.h @ 11132:a4611130e3eb

[gaim-migrate @ 13189] A bit more dewarnification. I also think I found a memleak in sametime. siege, could you please check that out sometime? committer: Tailor Script <[e-mail]>

--- a/src/util.h	Tue Jul 19 10:16:32 2005 +0000
+++ b/src/util.h	Wed Jul 20 02:43:09 2005 +0000
@@ -119,12 +119,22 @@
 
 /**
  * Converts a quoted printable string back to its readable equivalent.
+ * What is a quoted printable string, you ask?  It's an encoding used
+ * to transmit binary data as ASCII.  It's intended purpose is to send
+ * e-mails containing non-ASCII characters.  Wikipedia has a pretty good
+ * explanation.  Also see RFC 2045.
  *
- * @param str     The string to convert back.
+ * @param str     The quoted printable ASCII string to convert to raw data.
  * @param ret_str The returned, readable string.
- * @param ret_len The returned string length.
+ * @param ret_len The length of the returned data.  You can
+ *                pass in NULL if you're sure that you know
+ *                the length of the decoded data, or if you
+ *                know you'll be able to use strlen to
+ *                determine the length, etc.
+ *
+ * @return The raw data.  Must be g'free'd when no longer needed.
  */
-void gaim_quotedp_decode (const char *str, char **ret_str, int *ret_len);
+guint8 *gaim_quotedp_decode(const char *str, gsize *ret_len);
 
 /*@}*/