SRT documentation and web page updates

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

diff --git a/lib/silcutil/silctime.h b/lib/silcutil/silctime.h
index a049cca469b0e3deca59981d539cfb373c78556a..cd57d3afc53c2f14c82439d9bceb08beefd70a1f 100644 (file)
--- a/lib/silcutil/silctime.h
+++ b/lib/silcutil/silctime.h
@@ -59,6 +59,19 @@ typedef struct SilcTimeObject {
 } *SilcTime, SilcTimeStruct;
 /***/
 
+/****s* silcutil/SilcTimeStruct
+ *
+ * NAME
+ *
+ *    typedef struct { ... } *SilcTime, SilcTimeStruct;
+ *
+ * DESCRIPTION
+ *
+ *    This context represents time value.  It includes date and time
+ *    down to millisecond precision.  The structure size is 64 bits.
+ *
+ ***/
+
 /****f* silcutil/silc_time
  *
  * SYNOPSIS
@@ -122,7 +135,7 @@ const char *silc_time_string(SilcInt64 time_val_sec);
  *
  * SYNOPSIS
  *
- *   SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
+ *    SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
  *
  * DESCRIPTION
  *
@@ -134,6 +147,20 @@ const char *silc_time_string(SilcInt64 time_val_sec);
  ***/
 SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
 
+/****f* silcutil/silc_time_epoch
+ *
+ * SYNOPSIS
+ *
+ *    SilcUInt64 silc_time_epoch(SilcTime timeval);
+ *
+ * DESCRIPTION
+ *
+ *    Converts SilcTime into Epoch time value and returns the converted
+ *    value.
+ *
+ ***/
+SilcUInt64 silc_time_epoch(SilcTime timeval);
+
 /****f* silcutil/silc_timezone
  *
  * SYNOPSIS