Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[XBT] Amended docs for xbt/dict
authorChristian Heinrich <franz-christian.heinrich@inria.fr>
Wed, 17 Feb 2016 18:13:38 +0000 (19:13 +0100)
committerChristian Heinrich <franz-christian.heinrich@inria.fr>
Mon, 22 Feb 2016 13:57:55 +0000 (14:57 +0100)
src/xbt/dict.c

index 23c6132..95bda63 100644 (file)
@@ -21,7 +21,7 @@ XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_dict, xbt,
 /**
  * \brief Constructor
  * \return pointer to the destination
 /**
  * \brief Constructor
  * \return pointer to the destination
- * \see xbt_dict_free()
+ * \see xbt_dict_new_homogenous(), xbt_dict_free()
  *
  * Creates and initialize a new dictionary with a default hashtable size.
  * The dictionary is heterogeneous: each element can have a different free
  *
  * Creates and initialize a new dictionary with a default hashtable size.
  * The dictionary is heterogeneous: each element can have a different free
@@ -156,7 +156,9 @@ static void xbt_dict_rehash(xbt_dict_t dict)
  * \param key_len the size of the \a key
  * \param data the data to add in the dict
  * \param free_ctn function to call with (\a data as argument) when
  * \param key_len the size of the \a key
  * \param data the data to add in the dict
  * \param free_ctn function to call with (\a data as argument) when
- *        \a data is removed from the dictionary
+ *        \a data is removed from the dictionary. This param
+ *        will only be considered when the dict was instantiated with
+ *        xbt_dict_new() and not xbt_dict_new_homogeneous()
  *
  * Set the \a data in the structure under the \a key, which can be any kind
  * of data, as long as its length is provided in \a key_len.
  *
  * Set the \a data in the structure under the \a key, which can be any kind
  * of data, as long as its length is provided in \a key_len.
@@ -210,7 +212,9 @@ XBT_INLINE void xbt_dict_set_ext(xbt_dict_t dict,
  * \param key the key to set the new data
  * \param data the data to add in the dict
  * \param free_ctn function to call with (\a data as argument) when
  * \param key the key to set the new data
  * \param data the data to add in the dict
  * \param free_ctn function to call with (\a data as argument) when
- *        \a data is removed from the dictionary
+ *        \a data is removed from the dictionary. This param
+ *        will only be considered when the dict was instantiated with
+ *        xbt_dict_new() and not xbt_dict_new_homogeneous()
  *
  * set the \a data in the structure under the \a key, which is a
  * null terminated string.
  *
  * set the \a data in the structure under the \a key, which is a
  * null terminated string.