Comment changes.
authorPekka Riikonen <priikone@silcnet.org>
Thu, 17 Jan 2008 12:50:49 +0000 (12:50 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Thu, 17 Jan 2008 12:50:49 +0000 (12:50 +0000)
lib/silcutil/silcdir.h
lib/silcutil/silcdlist.h
lib/silcutil/silclist.h

index 25fb314b83994020168ef3b5b0ca63ab7e3837f0..2868d2033a7174f86d0c9ec38e189e0140d467d9 100644 (file)
@@ -69,7 +69,7 @@ typedef struct SilcDirStruct *SilcDir;
  ***/
 typedef struct SilcDirEntryStruct *SilcDirEntry;
 
-/****d* silcutil/SilcDirAPI/SilcDirEntryModen
+/****d* silcutil/SilcDirAPI/SilcDirEntryMode
  *
  * NAME
  *
index 2a5030a3ff3c96269a9169283da8d23294a68383..a27aaad41ca86fd5f9139a986e53fe3bf10e8322 100644 (file)
@@ -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
index 81ea3638bd8a468c9a4501c9eb55c1e353c9932c..66efd22fa7dd8667df1280a8ccff30a06e0464bc 100644 (file)
  *
  * 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