eina: correct document for eina_hash_list_prepend/remove.
authorThiep Ha <thiepha@gmail.com>
Sat, 25 Apr 2015 17:34:16 +0000 (19:34 +0200)
committerCedric BAIL <cedric@osg.samsung.com>
Sat, 25 Apr 2015 17:34:19 +0000 (19:34 +0200)
Summary:
The eina_hash_list_preprend/remove API have wrong description.
This patch fixes it.

@fix

Reviewers: Hermet, cedric

Reviewed By: cedric

Subscribers: cedric

Differential Revision: https://phab.enlightenment.org/D2423

Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>
src/lib/eina/eina_hash.h

index c19afa2ed54e74032ff285831d9a55c89da770b9..460af0044265acd1b85bf0ab6f294b87af1b7253 100644 (file)
@@ -1067,26 +1067,26 @@ EAPI void           eina_hash_foreach(const Eina_Hash  *hash,
  */
 EAPI void eina_hash_list_append(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3);
 /**
- * @brief Append data to an #Eina_List inside a hash
+ * @brief Prepend data to an #Eina_List inside a hash
  *
  * This function is identical to the sequence of calling
- * eina_hash_find(), eina_list_append(), eina_hash_set(),
+ * eina_hash_find(), eina_list_prepend(), eina_hash_set(),
  * but with one fewer required hash lookup.
  * @param hash The hash table
  * @param key The key associated with the data
- * @param data The data to append to the list
+ * @param data The data to prepend to the list
  * @since 1.10
  */
 EAPI void eina_hash_list_prepend(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3);
 /**
- * @brief Append data to an #Eina_List inside a hash
+ * @brief Remove data from an #Eina_List inside a hash
  *
  * This function is identical to the sequence of calling
- * eina_hash_find(), eina_list_append(), eina_hash_set(),
+ * eina_hash_find(), eina_list_remove(), eina_hash_set(),
  * but with one fewer required hash lookup.
  * @param hash The hash table
  * @param key The key associated with the data
- * @param data The data to append to the list
+ * @param data The data to remove from the list
  * @since 1.10
  */
 EAPI void eina_hash_list_remove(Eina_Hash *hash, const void *key, const void *data) EINA_ARG_NONNULL(1, 2, 3);