Wed, 02 May 2018 18:10:00 +0200
tell the user how allocation of property values works
src/ucx/properties.h | file | annotate | diff | comparison | revisions |
1.1 --- a/src/ucx/properties.h Wed May 02 16:14:40 2018 +0200 1.2 +++ b/src/ucx/properties.h Wed May 02 18:10:00 2018 +0200 1.3 @@ -173,12 +173,15 @@ 1.4 * Retrieves all available key/value-pairs and puts them into a UcxMap. 1.5 * 1.6 * This is done by successive calls to ucx_properties_next() until no more 1.7 - * key/value-pairs can be retrieved. 1.8 + * key/value-pairs can be retrieved. 1.9 + * 1.10 + * The memory for the map values is allocated by the map's own allocator. 1.11 * 1.12 * @param prop the UcxProperties object 1.13 * @param map the target map 1.14 * @return The UcxProperties.error code (i.e. 0 on success). 1.15 * @see ucx_properties_fill() 1.16 + * @see UcxMap.allocator 1.17 */ 1.18 int ucx_properties2map(UcxProperties *prop, UcxMap *map); 1.19