Added SILC Thread Queue API

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

diff --git a/lib/silcutil/silcdlist.h b/lib/silcutil/silcdlist.h
index 238c008e60fd126c7c660ecf88e985e219dba6f0..a27aaad41ca86fd5f9139a986e53fe3bf10e8322 100644 (file)
--- a/lib/silcutil/silcdlist.h
+++ b/lib/silcutil/silcdlist.h
@@ -27,7 +27,7 @@
  * DESCRIPTION
  *
  * SILC Dynamic List API can be used to add opaque contexts to list that
- * will automatically allocate list entries.  Normal SILC List API cannot
+ * will automatically allocate list entries.  The simpler SilcList cannot
  * be used for this purpose because in that case the context passed to the
  * list must be defined as list structure already.  This is not the case in
  * SilcDList.  But SilcDList is a bit slower than SilcList because it
@@ -36,6 +36,21 @@
  * SILC Dynamic List is not thread-safe.  If the same list context must be
  * used in multithreaded environment concurrency control must be employed.
  *
+ * EXAMPLE
+ *
+ * SilcDList list = silc_dlist_init();
+ *
+ * silc_dlist_add(list, entry1);
+ * silc_dlist_add(list, entry2);
+ *
+ * // Traverse the list from the beginning to the end
+ * silc_dlist_start(list)
+ * while ((entry = silc_dlist_get(list)) != SILC_LIST_END) {
+ *      ...
+ * }
+ *
+ * silc_dlist_uninit(list);
+ *
  ***/
 
 /****s* silcutil/SilcDListAPI/SilcDList
@@ -75,7 +90,8 @@ typedef struct SilcDListEntryStruct {
  *
  * DESCRIPTION
  *
- *    Initializes SilcDList.  Returns the SilcDList context or NULL on error.
+ *    Initializes SilcDList.  Returns the SilcDList context or NULL if system
+ *    is out of memory.
  *
  ***/