docs/Writerside/topics/properties.h.md

changeset 1553
7c46531efd52
parent 1424
563033aa998c
child 1555
8972247f54e8
--- a/docs/Writerside/topics/properties.h.md	Sun Dec 07 13:18:22 2025 +0100
+++ b/docs/Writerside/topics/properties.h.md	Sun Dec 07 13:24:18 2025 +0100
@@ -27,6 +27,13 @@
 
 ## Basic Parsing
 
+The following listing shows the properties-parser API.
+
+> To simplify documentation, we introduce the pseudo-type `AnyStr` with the meaning that
+> any UCX string and any C string are supported.
+> The implementation is actually hidden behind a macro which uses `cx_strcast()` to guarantee compatibility.
+{style="note"}
+
 ```C
 #include <cx/properties.h>
 
@@ -50,8 +57,7 @@
 int cxPropertiesFilln(CxProperties *prop,
         const char *buf, size_t len);
 
-// where S is one of cxstring, cxmutstr, char*, const char*
-int cxPropertiesFill(CxProperties *prop, S string);
+int cxPropertiesFill(CxProperties *prop, AnyStr string);
 
 CxPropertiesStatus cxPropertiesNext(CxProperties *prop,
         cxstring *key, cxstring *value);

mercurial