Mercurial > pidgin.yaz
changeset 26754:f857ec889c7b
Exposing the GHashTable seems crazy to me. See #8644.
| author | Paul Aurich <paul@darkrain42.org> |
|---|---|
| date | Thu, 12 Mar 2009 05:56:04 +0000 |
| parents | f22ecddd3eba |
| children | 1af02540d7b3 |
| files | libpurple/blist.h |
| diffstat | 1 files changed, 8 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/libpurple/blist.h Thu Mar 12 05:32:25 2009 +0000 +++ b/libpurple/blist.h Thu Mar 12 05:56:04 2009 +0000 @@ -118,8 +118,8 @@ /** * A Buddy list node. This can represent a group, a buddy, or anything else. - * This is a base class for struct buddy and struct group and for anything - * else that wants to put itself in the buddy list. */ + * This is a base class for PurpleBuddy, PurpleContact, PurpleGroup, and for + * anything else that wants to put itself in the buddy list. */ struct _PurpleBlistNode { PurpleBlistNodeType type; /**< The type of node this is */ PurpleBlistNode *prev; /**< The sibling before this buddy. */ @@ -207,7 +207,7 @@ PurpleBlistNode *node); /**< This will update a node in the buddy list. */ void (*remove)(PurpleBuddyList *list, PurpleBlistNode *node); /**< This removes a node from the list */ - void (*destroy)(PurpleBuddyList *list); /**< When the list gets destroyed, this gets called to destroy the UI. */ + void (*destroy)(PurpleBuddyList *list); /**< When the list is destroyed, this is called to destroy the UI. */ void (*set_visible)(PurpleBuddyList *list, gboolean show); /**< Hides or unhides the buddy list */ void (*request_add_buddy)(PurpleAccount *account, const char *username, @@ -261,6 +261,11 @@ /** * Returns the hash table of every buddy in the list. + * You MUST treat this data structure as immutable. The only use should + * be for iterating over the values (PurpleBuddy*) in performance-critical + * code. + * + * @see purple_find_buddy for the recommended alternative. * * @return The hash table of every buddy in the list. *