changeset 29399:36da826c6002

Update pidgin_blist_get_emblem() docs to be accurate.
author Daniel Atallah <daniel.atallah@gmail.com>
date Thu, 18 Feb 2010 16:58:42 +0000
parents ae1c7756f1bd
children dd3c5b3dd3e0
files pidgin/gtkblist.h
diffstat 1 files changed, 5 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- 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);