Added examples to headers.

[crypto.git] / lib / silcutil / silctimer.h

diff --git a/lib/silcutil/silctimer.h b/lib/silcutil/silctimer.h
index 79c57750da8c013294f89dd76d95291f429adc26..c53da041908c962b8311fcb302798e83c51eed02 100644 (file)
--- a/lib/silcutil/silctimer.h
+++ b/lib/silcutil/silctimer.h
@@ -18,10 +18,21 @@
 */
 
 /****h* silcutil/SILC Timer Interface
+ *
+ * DESCRIPTION
  *
  * SILC Timer interface provides a simple way to measure time intervals.
  * The SILC Timer works with microsecond resolution, depending on platform.
  *
+ * EXAMPLE
+ *
+ * SilcTimerStruct timer;
+ *
+ * silc_timer_start(&timer);
+ * ... time passes ...
+ * silc_timer_stop(&timer);
+ * silc_timer_value(&timer, &elapsed_sec, &elapsed_usec);
+ *
  ***/
 
 #ifndef SILCTIMER_H