From e99bfc612e0c9b088dfc3ac0073ce2ed5eb9fe7f Mon Sep 17 00:00:00 2001 From: Pekka Riikonen Date: Thu, 9 Nov 2006 16:11:36 +0000 Subject: [PATCH] Comment fixes. --- lib/silcutil/silchashtable.c | 5 +++-- lib/silcutil/silchashtable.h | 14 +++++++++++--- 2 files changed, 14 insertions(+), 5 deletions(-) diff --git a/lib/silcutil/silchashtable.c b/lib/silcutil/silchashtable.c index 9fbd9895..b166644b 100644 --- a/lib/silcutil/silchashtable.c +++ b/lib/silcutil/silchashtable.c @@ -4,7 +4,7 @@ Author: Pekka Riikonen - 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; diff --git a/lib/silcutil/silchashtable.h b/lib/silcutil/silchashtable.h index 687170f9..f7d21cb4 100644 --- a/lib/silcutil/silchashtable.h +++ b/lib/silcutil/silchashtable.h @@ -4,7 +4,7 @@ Author: Pekka Riikonen - 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, -- 2.43.0