From 16fd04cc94435d3f6fe207d2b9fc186223fe2521 Mon Sep 17 00:00:00 2001 From: Bryce Harrington Date: Wed, 2 May 2018 19:45:59 -0400 Subject: [PATCH] eina: Revise documentation for eina_hash_foreach Summary: Reword description to clarify what it does. Reviewers: cedric Tags: #efl Differential Revision: https://phab.enlightenment.org/D6022 --- src/lib/eina/eina_hash.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/lib/eina/eina_hash.h b/src/lib/eina/eina_hash.h index 9a2677ce36..6efdfce34b 100644 --- a/src/lib/eina/eina_hash.h +++ b/src/lib/eina/eina_hash.h @@ -987,11 +987,11 @@ EAPI Eina_Iterator *eina_hash_iterator_tuple_new(const Eina_Hash *hash) EINA_MAL * @param func The function to call on each parameter. * @param fdata The data pointer to pass to the function being called. * - * This function goes through every entry in the hash table @p hash and calls - * the function @p func on each member. The function should @b not modify the - * hash table contents if it returns @c 1. @b If the hash table contents are - * modified by this function or the function wishes to stop processing it must - * return @c 0, otherwise return @c 1 to keep processing. + * This function iterates over the hash table @p hash, calling the + * function @p func on each member. If @p func modifies the contents + * of the hash table, or wishes to stop processing it should return + * #EINA_FALSE. If @p func returns #EINA_TRUE the foreach loop will + * keep processing. * * Example: * @code @@ -1002,7 +1002,7 @@ EAPI Eina_Iterator *eina_hash_iterator_tuple_new(const Eina_Hash *hash) EINA_MAL * { * printf("Func data: %s, Hash entry: %s / %p\n", * fdata, (const char *)key, data); - * return 1; + * return EINA_TRUE; * } * * int main(int argc, char **argv)