Added examples to headers.

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

diff --git a/lib/silcutil/silcatomic.h b/lib/silcutil/silcatomic.h
index 3a49aecf07f039d78de8d1241cd13ed470bbe597..5f3ea2e15520d9111b021abf7d86beccccfa10ac 100644 (file)
--- a/lib/silcutil/silcatomic.h
+++ b/lib/silcutil/silcatomic.h
@@ -35,6 +35,19 @@
  *
  * Fast operations are supported on: x86, x86_64, ia64, PPC
  *
+ * EXAMPLE
+ *
+ * SilcAtomic32 refcnt;
+ *
+ * // Initialize atomic variable
+ * silc_atomic_init32(&refcnt, 0);
+ *
+ * // Increment referene counter by one
+ * silc_atomic_add_int32(&refcnt, 1);
+ *
+ * // Uninitialize atomic variable
+ * silc_atomic_uninit32(&refcnt);
+ *
  ***/
 
 #ifndef SILCATOMIC_H