fix the note about AnyStr and add it to the files where it was missing

Sun, 07 Dec 2025 13:24:18 +0100

author
Mike Becker <universe@uap-core.de>
date
Sun, 07 Dec 2025 13:24:18 +0100
changeset 1553
7c46531efd52
parent 1552
a114fc4a285a
child 1554
91fb10c89611

fix the note about AnyStr and add it to the files where it was missing

docs/Writerside/topics/json.h.md file | annotate | diff | comparison | revisions
docs/Writerside/topics/properties.h.md file | annotate | diff | comparison | revisions
docs/Writerside/topics/string.h.md file | annotate | diff | comparison | revisions
--- a/docs/Writerside/topics/json.h.md	Sun Dec 07 13:18:22 2025 +0100
+++ b/docs/Writerside/topics/json.h.md	Sun Dec 07 13:24:18 2025 +0100
@@ -7,6 +7,13 @@
 
 ## Parser
 
+The following listing shows the JSON 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/json.h>
 
--- 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);
--- a/docs/Writerside/topics/string.h.md	Sun Dec 07 13:18:22 2025 +0100
+++ b/docs/Writerside/topics/string.h.md	Sun Dec 07 13:24:18 2025 +0100
@@ -9,8 +9,10 @@
 
 ## Basics
 
+The following listing shows basic string functions.
+
 > To simplify documentation, we introduce the pseudo-type `AnyStr` with the meaning that
-> both `cxstring` and `cxmutstr` are accepted for that argument.
+> 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"}
 

mercurial