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

eina: add documentation for the tricky eina_hash_pointer_new

This commit is contained in:
Cedric BAIL 2014-08-21 13:47:59 +02:00
parent 78acf69e20
commit 1a571fc689
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -499,6 +499,15 @@ EAPI Eina_Hash *eina_hash_int64_new(Eina_Free_Cb data_free_cb);
* original key pointer that was used to add values. This method may * original key pointer that was used to add values. This method may
* appear to be able to match string keys, actually it only matches * appear to be able to match string keys, actually it only matches
* the first character. On failure, this function returns @c NULL. * the first character. On failure, this function returns @c NULL.
*
* @code
* // For a hash that will have only one pointer to each structure
* extern Eina_Hash *hash;
* extern void *data;
*
* if (!eina_hash_find(hash, &data))
* eina_hash_add(hash, &data, data);
* @endcode
*/ */
EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb); EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb);
@ -523,7 +532,7 @@ EAPI Eina_Hash *eina_hash_pointer_new(Eina_Free_Cb data_free_cb);
* const char *a = eina_stringshare_add("key"); * const char *a = eina_stringshare_add("key");
* *
* eina_hash_add(hash, a, value); * eina_hash_add(hash, a, value);
* eina_hash_find(hash, "key") * eina_hash_find(hash, "key");
* @endcode * @endcode
*/ */
EAPI Eina_Hash *eina_hash_stringshared_new(Eina_Free_Cb data_free_cb); EAPI Eina_Hash *eina_hash_stringshared_new(Eina_Free_Cb data_free_cb);