changeset 24797:9216da5184a2

Add a comment that 0 should be used when a buddies idle time is unknown
author Mark Doliner <mark@kingant.net>
date Wed, 17 Dec 2008 18:21:47 +0000
parents c2054d8d23fc
children a8643ca8d2e0
files libpurple/prpl.h libpurple/status.h
diffstat 2 files changed, 4 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/libpurple/prpl.h	Wed Dec 17 05:39:11 2008 +0000
+++ b/libpurple/prpl.h	Wed Dec 17 18:21:47 2008 +0000
@@ -637,7 +637,8 @@
  * @param idle      The user's idle state.
  * @param idle_time The user's idle time.  This is the time at
  *                  which the user became idle, in seconds since
- *                  the epoch.
+ *                  the epoch.  If the PRPL does not know this value
+ *                  then it should pass 0.
  */
 void purple_prpl_got_user_idle(PurpleAccount *account, const char *name,
 							 gboolean idle, time_t idle_time);
--- a/libpurple/status.h	Wed Dec 17 05:39:11 2008 +0000
+++ b/libpurple/status.h	Wed Dec 17 18:21:47 2008 +0000
@@ -823,7 +823,8 @@
  * @param idle      The idle state.
  * @param idle_time The idle time, if @a idle is TRUE.  This
  *                  is the time at which the user became idle,
- *                  in seconds since the epoch.
+ *                  in seconds since the epoch.  If this value is
+ *                  unknown then 0 should be used.
  */
 void purple_presence_set_idle(PurplePresence *presence, gboolean idle,
 							time_t idle_time);