/pidgin/main: 5338b7ae4f73: Be more clear in the doc about what ...

[Mark Doliner]

Changeset: 5338b7ae4f73f37f2c00b59e5f7258ad6df6042a
Author:	 Mark Doliner <mark at kingant.net>
Date:	 2013-04-14 11:34 -0700
Branch:	 default
URL: https://hg.pidgin.im/pidgin/main/rev/5338b7ae4f73

Description:

Be more clear in the doc about what should be freed.

diffstat:

 libpurple/blist.h |  5 ++++-
 1 files changed, 4 insertions(+), 1 deletions(-)

diffs (15 lines):

diff --git a/libpurple/blist.h b/libpurple/blist.h
--- a/libpurple/blist.h
+++ b/libpurple/blist.h
@@ -862,7 +862,10 @@ PurpleBuddy *purple_find_buddy_in_group(
  * @param account The account this buddy belongs to
  * @param name    The buddy's name (or NULL to return all buddies for the account)
  *
- * @return        A GSList of buddies (which must be freed), or NULL if the buddy doesn't exist
+ * @return        NULL if the buddy doesn't exist, or a GSList of
+ *                PurpleBuddy structs.  You must free the GSList using
+ *                g_slist_free.  Do not free the PurpleBuddy structs that
+ *                the list points to.
  */
 GSList *purple_find_buddies(PurpleAccount *account, const char *name);