changeset 27204:d06f9250cf5a

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.
author Mark Doliner <mark@kingant.net>
date Fri, 19 Jun 2009 00:06:49 +0000
parents 350f097019eb
children 3ea4e638ce81
files libpurple/notify.h
diffstat 1 files changed, 3 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/notify.h	Fri Jun 19 00:01:39 2009 +0000
+++ b/libpurple/notify.h	Fri Jun 19 00:06:49 2009 +0000
@@ -427,7 +427,9 @@
  * 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.