Update pidgin_blist_get_emblem() docs to be accurate.

Thu, 18 Feb 2010 16:58:42 +0000

author
Daniel Atallah <datallah@pidgin.im>
date
Thu, 18 Feb 2010 16:58:42 +0000
changeset 29728
62c59080a6bf
parent 29727
5359b79e2b47
child 29729
6c025efd4369

Update pidgin_blist_get_emblem() docs to be accurate.

pidgin/gtkblist.h file | annotate | diff | comparison | revisions
--- a/pidgin/gtkblist.h	Thu Feb 18 16:43:29 2010 +0000
+++ b/pidgin/gtkblist.h	Thu Feb 18 16:58:42 2010 +0000
@@ -196,11 +196,14 @@
 void pidgin_blist_update_refresh_timeout(void);
 
 /**
- * Returns the blist emblem
+ * Returns the blist emblem.
+ *
+ * This may be an existing pixbuf that has been given an additional ref,
+ * so it shouldn't be modified.
  *
  * @param node   The node to return an emblem for
  *
- * @return  A newly created GdkPixbuf, or NULL
+ * @return  A GdkPixbuf for the emblem to show, or NULL
  */
 GdkPixbuf *
 pidgin_blist_get_emblem(PurpleBlistNode *node);

mercurial