1.1 --- a/src/ucx/map.h Tue Jan 23 19:23:34 2018 +0100
1.2 +++ b/src/ucx/map.h Wed May 02 16:14:40 2018 +0200
1.3 @@ -158,7 +158,10 @@
1.4 * Frees the contents of a hash map.
1.5 *
1.6 * This is a convenience function that iterates over the map and passes all
1.7 - * values to the specified destructor function (e.g. stdlib free()).
1.8 + * values to the specified destructor function.
1.9 + *
1.10 + * If no destructor is specified (<code>NULL</code>), the free() function of
1.11 + * the map's own allocator is used.
1.12 *
1.13 * You must ensure, that it is valid to pass each value in the map to the same
1.14 * destructor function.
1.15 @@ -166,7 +169,7 @@
1.16 * You should free or clear the map afterwards, as the contents will be invalid.
1.17 *
1.18 * @param map for which the contents shall be freed
1.19 - * @param destr pointer to the destructor function
1.20 + * @param destr optional pointer to a destructor function
1.21 * @see ucx_map_free()
1.22 * @see ucx_map_clear()
1.23 */
