From 30b8fb532138b2d9b523d3c069724e78fb72f8e3 Mon Sep 17 00:00:00 2001 From: Pekka Riikonen Date: Thu, 17 Jan 2008 12:50:49 +0000 Subject: [PATCH] Comment changes. --- lib/silcutil/silcdir.h | 2 +- lib/silcutil/silcdlist.h | 2 +- lib/silcutil/silclist.h | 17 +++++++++++++++-- 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/lib/silcutil/silcdir.h b/lib/silcutil/silcdir.h index 25fb314b..2868d203 100644 --- a/lib/silcutil/silcdir.h +++ b/lib/silcutil/silcdir.h @@ -69,7 +69,7 @@ typedef struct SilcDirStruct *SilcDir; ***/ typedef struct SilcDirEntryStruct *SilcDirEntry; -/****d* silcutil/SilcDirAPI/SilcDirEntryModen +/****d* silcutil/SilcDirAPI/SilcDirEntryMode * * NAME * diff --git a/lib/silcutil/silcdlist.h b/lib/silcutil/silcdlist.h index 2a5030a3..a27aaad4 100644 --- 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 diff --git a/lib/silcutil/silclist.h b/lib/silcutil/silclist.h index 81ea3638..66efd22f 100644 --- 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 -- 2.24.0