Mercurial > hg > toolkit / file diff

--- a/ucx/cx/properties.h	Mon Jun 16 21:41:55 2025 +0200
+++ b/ucx/cx/properties.h	Fri Jun 20 12:01:08 2025 +0200
@@ -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 default stdlib allocator will be used, unless you specify a custom
- * allocator in the optional @c data of the sink.
+ * 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 cxDefaultAllocator will be used unless you specify a custom
+ * 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