Comment fixes.
authorPekka Riikonen <priikone@silcnet.org>
Thu, 9 Nov 2006 16:11:36 +0000 (16:11 +0000)
committerPekka Riikonen <priikone@silcnet.org>
Thu, 9 Nov 2006 16:11:36 +0000 (16:11 +0000)
lib/silcutil/silchashtable.c
lib/silcutil/silchashtable.h

index 9fbd98954bad391dd1f1009885ddc63daaf52fed..b166644b287c1df06a5bf3f97957b4f436033b16 100644 (file)
@@ -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
@@ -935,7 +935,8 @@ void silc_hash_table_list_reset(SilcHashTableList *htl)
    `context' and TRUE.  If this returns FALSE then there are no anymore
    any entrys. Usage: while (silc_hash_table_get(&htl, &key, &context)) */
 
-SilcBool silc_hash_table_get(SilcHashTableList *htl, void **key, void **context)
+SilcBool silc_hash_table_get(SilcHashTableList *htl, void **key,
+                            void **context)
 {
   SilcHashTableEntry entry = (SilcHashTableEntry)htl->entry;
 
index 687170f9a4585a7efb9a9b99a9d8754dc5900da7..f7d21cb4eb51e1cf14c8b7087d4f0e6ffb3e998d 100644 (file)
@@ -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,