Comment changes.

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

diff --git a/lib/silcutil/silclist.h b/lib/silcutil/silclist.h
index 81ea3638bd8a468c9a4501c9eb55c1e353c9932c..66efd22fa7dd8667df1280a8ccff30a06e0464bc 100644 (file)
--- a/lib/silcutil/silclist.h
+++ b/lib/silcutil/silclist.h
@@ -21,12 +21,25 @@
  *
  * DESCRIPTION
  *
- * Implementation of the SilcList interface.  This interface provides
- * simple linked list.  This interface does not allocate any memory.
+ * Generic list interface that can turn any structure with list pointers
+ * into a SilcList.  The interface can provide both singly and doubly linked
+ * lists.  The interface does not allocate any memory.
  *
  * SILC List is not thread-safe.  If the same list context must be used
  * in multithreaded environment concurrency control must be employed.
  *
+ * EXAMPLE
+ *
+ * struct EntryStruct {
+ *   char *dummy;
+ *   struct EntryStruct *next;        // The list member pointer
+ * };
+ *
+ * SilcList list;
+ *
+ * // Initialize list
+ * silc_list_init(list, struct EntryStruct, next);
+ *
  ***/
 
 #ifndef SILCLIST_H