kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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
This commit is contained in:
Bryce Harrington 2018-05-02 19:45:59 -04:00 committed by Mike Blumenkrantz
parent 43aac2f7de
commit 16fd04cc94
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/lib/eina/eina_hash.h
View File

@ -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)