Mercurial > hg > ucx / changeset

--- a/src/ucx/properties.h	Wed May 02 16:14:40 2018 +0200
+++ b/src/ucx/properties.h	Wed May 02 18:10:00 2018 +0200
@@ -173,12 +173,15 @@
  * Retrieves all available key/value-pairs and puts them into a UcxMap.
  * 
  * This is done by successive calls to ucx_properties_next() until no more
- * key/value-pairs can be retrieved. 
+ * key/value-pairs can be retrieved.
+ * 
+ * The memory for the map values is allocated by the map's own allocator.
  * 
  * @param prop the UcxProperties object
  * @param map the target map
  * @return The UcxProperties.error code (i.e. 0 on success).
  * @see ucx_properties_fill()
+ * @see UcxMap.allocator
  */
 int ucx_properties2map(UcxProperties *prop, UcxMap *map);