forked from enlightenment/efl
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:
parent
43aac2f7de
commit
16fd04cc94
|
@ -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 func The function to call on each parameter.
|
||||||
* @param fdata The data pointer to pass to the function being called.
|
* @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
|
* This function iterates over the hash table @p hash, calling the
|
||||||
* the function @p func on each member. The function should @b not modify the
|
* function @p func on each member. If @p func modifies the contents
|
||||||
* hash table contents if it returns @c 1. @b If the hash table contents are
|
* of the hash table, or wishes to stop processing it should return
|
||||||
* modified by this function or the function wishes to stop processing it must
|
* #EINA_FALSE. If @p func returns #EINA_TRUE the foreach loop will
|
||||||
* return @c 0, otherwise return @c 1 to keep processing.
|
* keep processing.
|
||||||
*
|
*
|
||||||
* Example:
|
* Example:
|
||||||
* @code
|
* @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",
|
* printf("Func data: %s, Hash entry: %s / %p\n",
|
||||||
* fdata, (const char *)key, data);
|
* fdata, (const char *)key, data);
|
||||||
* return 1;
|
* return EINA_TRUE;
|
||||||
* }
|
* }
|
||||||
*
|
*
|
||||||
* int main(int argc, char **argv)
|
* int main(int argc, char **argv)
|
||||||
|
|
Loading…
Reference in New Issue