Mercurial > hg > ucx / file diff

--- a/src/cx/properties.h	Fri Feb 28 19:07:47 2025 +0100
+++ b/src/cx/properties.h	Sat Mar 01 15:02:57 2025 +0100
@@ -551,10 +551,12 @@
 /**
  * Creates a properties sink for an UCX map.
  *
- * The values stored in the map will be pointers to strings allocated
- * by #cx_strdup_a().
+ * The values stored in the map will be pointers to freshly allocated,
+ * zero-terminated C strings (@c char*), which means the @p map should have been
+ * created with #CX_STORE_POINTERS.
+ *
  * The default stdlib allocator will be used, unless you specify a custom
- * allocator in the optional @c data of the sink.
+ * allocator in the optional @c data field of the returned sink.
  *
  * @param map the map that shall consume the k/v-pairs.
  * @return the sink