Merge branch 'topic/mm-fixes' of git://208.110.73.182/silc into silc.1.1.branch

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

diff --git a/lib/silcutil/silchashtable.h b/lib/silcutil/silchashtable.h
index 687170f9a4585a7efb9a9b99a9d8754dc5900da7..f7d21cb4eb51e1cf14c8b7087d4f0e6ffb3e998d 100644 (file)
--- a/lib/silcutil/silchashtable.h
+++ b/lib/silcutil/silchashtable.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2001 - 2005 Pekka Riikonen
+  Copyright (C) 2001 - 2006 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -461,8 +461,16 @@ void silc_hash_table_list_reset(SilcHashTableList *htl);
  * DESCRIPTION
  *
  *    Returns always the next entry in the hash table into the `key' and
- *    `context' and TRUE.  If this returns FALSE then there are no anymore
- *    any entrys.
+ *    `context' and TRUE.  If this returns FALSE then there are no more
+ *    entries.
+ *
+ * EXAMPLE
+ *
+ *    SilcHashTableList htl;
+ *    silc_hash_table_list(hash_table, &htl);
+ *    while (silc_hash_table_get(&htl, (void *)&key, (void *)&context))
+ *      ...
+ *    silc_hash_table_list_reset(&htl);
  *
  ***/
 SilcBool silc_hash_table_get(SilcHashTableList *htl,