# HG changeset patch
# User Mike Becker <universe@uap-core.de>
# Date 1525277400 -7200
# Node ID 7b9170c22786dbf77c9c4cb66681a63d5cb926fc
# Parent  f819fe5e20f544f8be6c5c8a40cf4ab94650cc93
tell the user how allocation of property values works

diff -r f819fe5e20f5 -r 7b9170c22786 src/ucx/properties.h
--- 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);