pidgin: 51955f6d: Add a comment that 0 should be used when...

[markdoliner at pidgin.im]

-----------------------------------------------------------------
Revision: 51955f6d3b1f210f42dbdb08e2260e03b956759f
Ancestor: a03e0bee477b05d1143ef3e5607d990c1120da34
Author: markdoliner at pidgin.im
Date: 2008-12-17T18:21:47
Branch: im.pidgin.pidgin
URL: http://d.pidgin.im/viewmtn/revision/info/51955f6d3b1f210f42dbdb08e2260e03b956759f

Modified files:
        libpurple/prpl.h libpurple/status.h

ChangeLog: 

Add a comment that 0 should be used when a buddies idle time is unknown

-------------- next part --------------
============================================================
--- libpurple/prpl.h	b6a33591369ebb9f8aa226725e207c8fd6fdd8b2
+++ libpurple/prpl.h	f93c6c9088ab8fd3d2984da02ace7121f7dab5f5
@@ -637,7 +637,8 @@ void purple_prpl_got_account_status(Purp
  * @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);
============================================================
--- libpurple/status.h	c58271a5bf73d2787cc7245b7884c3cf967e1e0b
+++ libpurple/status.h	bf743bb2f9ff270ecc5bec8053fbba7aa39316fb
@@ -823,7 +823,8 @@ void purple_presence_switch_status(Purpl
  * @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);