pidgin: 1a7e0684: Super minor documentation improvement

[markdoliner at pidgin.im]

-----------------------------------------------------------------
Revision: 1a7e06847c54bcc655b26e490e252226cb700af6
Ancestor: 903e0b0567e45554fcadd6b7776eca2c4ad94200
Author: markdoliner at pidgin.im
Date: 2008-04-16T06:27:46
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/1a7e06847c54bcc655b26e490e252226cb700af6

Modified files:
        libpurple/blist.h libpurple/util.h

ChangeLog: 

Super minor documentation improvement

-------------- next part --------------
============================================================
--- libpurple/blist.h	4dfb47ccb73205a2f3e6abd6afd4c7057b6cc8c2
+++ libpurple/blist.h	c81af827e59257afd3a1fb730a3f9d55a8c0ae68
@@ -475,7 +475,8 @@ PurplePresence *purple_buddy_get_presenc
  * @param buddy   The new buddy who gets added
  * @param contact The optional contact to place the buddy in.
  * @param group   The group to add the new buddy to.
- * @param node    The insertion point
+ * @param node    The insertion point.  Pass in NULL to add the node as
+ *                the last child in the given group.
  */
 void purple_blist_add_buddy(PurpleBuddy *buddy, PurpleContact *contact, PurpleGroup *group, PurpleBlistNode *node);
 
============================================================
--- libpurple/util.h	a13409f3a6072c3d5aea48f3df892aeaf761fc71
+++ libpurple/util.h	9a0e565f2cc2f405d95c47c3e66e2875ae081b89
@@ -476,7 +476,8 @@ void purple_markup_html_to_xhtml(const c
  *
  * @param str The string to strip HTML from.
  *
- * @return The new string without HTML. This must be freed.
+ * @return The new string without HTML.  You must g_free this string
+ *         when finished with it.
  */
 char *purple_markup_strip_html(const char *str);
 
@@ -485,7 +486,9 @@ char *purple_markup_strip_html(const cha
  *
  * @param str The string to linkify.
  *
- * @return The linkified text.
+ * @return The new string with all URIs surrounded in standard
+ *         HTML <a href="whatever"></a> tags.  You must g_free this
+ *         string when finished with it.
  */
 char *purple_markup_linkify(const char *str);
 
@@ -497,7 +500,8 @@ char *purple_markup_linkify(const char *
  *
  * @param html The string in which to unescape any HTML entities
  *
- * @return the text with HTML entities literalized
+ * @return The text with HTML entities literalized.  You must g_free
+ *         this string when finished with it.
  */
 char *purple_unescape_html(const char *html);