pidgin: 55a16008: Update pidgin_blist_get_emblem() docs to...

[datallah at pidgin.im]

-----------------------------------------------------------------
Revision: 55a16008b0092250d9f1d0b0c9a93c21106d278d
Ancestor: caa0ae301c89eeec679cba854aae8b0fa27970e5
Author: datallah at pidgin.im
Date: 2010-02-18T16:58:42
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/55a16008b0092250d9f1d0b0c9a93c21106d278d

Modified files:
        pidgin/gtkblist.h

ChangeLog: 

Update pidgin_blist_get_emblem() docs to be accurate.

-------------- next part --------------
============================================================
--- pidgin/gtkblist.h	051c7756e2185afff3536ad3c7f8161e99878f52
+++ pidgin/gtkblist.h	179ac0c879f7f20d209dd08d36029a11ecd03482
@@ -196,11 +196,14 @@ void pidgin_blist_update_refresh_timeout
 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);