silc_compare_timeval returns < 0, 0, > 0 instead of TRUE/FALSE.

[silc.git] / lib / silcutil / silctime.h

diff --git a/lib/silcutil/silctime.h b/lib/silcutil/silctime.h
index 60963736cfcae14c3ad068fbc97649ff3e6e5d95..03cdb5566cdf3ab050f87722afc4694fa041edd2 100644 (file)
--- a/lib/silcutil/silctime.h
+++ b/lib/silcutil/silctime.h
@@ -145,7 +145,8 @@ SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
  *    Returns current timezone in Universal time format into the `timezone'
  *    buffer of size of `timezone_size'.  The possible values this function
  *    returns are: Z (For UTC timezone), +hh (UTC + hours) -hh (UTC - hours),
- *    +hh:mm (UTC + hours:minutes) or -hh:mm (UTC - hours:minutes).
+ *    +hh:mm (UTC + hours:minutes) or -hh:mm (UTC - hours:minutes).  The
+ *    returned values are always offsets to UTC.
  *
  *    Returns FALSE on error, TRUE otherwise.
  *
@@ -246,17 +247,16 @@ SilcBool silc_time_generalized_string(SilcTime time_val, char *ret_string,
  *
  * SYNOPSIS
  *
- *    SilcBool silc_compare_timeval(struct time_val *smaller,
- *                                  struct time_val *bigger)
+ *    int silc_compare_timeval(struct time_val *t1, struct time_val *t2);
  *
  * DESCRIPTION
  *
- *    Compare two timeval structures and return TRUE if the first
- *    time value is smaller than the second time value.
+ *    Compares `t1' and `t2' time structures and returns less than zero, 
+ *    zero or more than zero when `t1' is smaller, equal or bigger than
+ *    `t2', respectively.
  *
  ***/
-SilcBool silc_compare_timeval(struct timeval *smaller,
-                             struct timeval *bigger);
+int silc_compare_timeval(struct timeval *t1, struct timeval *t2);
 
 /****f* silcutil/SilcTimeAPI/silc_gettimeofday
  *