pidgin: 97a66c06: Clarify this. This count gets passed ar...

[markdoliner at pidgin.im]

-----------------------------------------------------------------
Revision: 97a66c0626bacf523c2e9139e4ac9da24bebf44f
Ancestor: 89a4f316ede32e2eec84d699c536292a6e5335eb
Author: markdoliner at pidgin.im
Date: 2009-06-19T00:06:49
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/97a66c0626bacf523c2e9139e4ac9da24bebf44f

Modified files:
        libpurple/notify.h

ChangeLog: 

Clarify this.  This count gets passed around a lot of places... I'm
not really sure where the best place is to document this.  Maybe
PurpleNotifyUiOps, but we don't have any documentation there right now.

-------------- next part --------------
============================================================
--- libpurple/notify.h	a1e4170e9df67a42eaf9db3491e39a3e257387c2
+++ libpurple/notify.h	7f0ec15f9a265e079c8d0585a9c4fdd65f3dded3
@@ -427,7 +427,9 @@ void *purple_notify_email(void *handle, 
  * Displays a notification for multiple emails to the user.
  *
  * @param handle    The plugin or connection handle.
- * @param count     The number of emails.
+ * @param count     The number of emails.  '0' can be used to signify that
+ *                  the user has no unread emails and the UI should remove
+ *                  the mail notification.
  * @param detailed  @c TRUE if there is information for each email in the
  *                  arrays.
  * @param subjects  The array of subjects.