--- a/docs/Writerside/topics/properties.h.md Sat Oct 11 15:42:48 2025 +0200 +++ b/docs/Writerside/topics/properties.h.md Sun Oct 12 20:21:56 2025 +0200 @@ -1,6 +1,6 @@ # Properties -The UCX properties parser can be used to parse line based key/value strings. +The UCX properties parser can be used to parse line-based key/value strings. ## Supported Syntax @@ -61,7 +61,7 @@ ``` The first step is to initialize a `CxProperties` structure with a call to `cxPropertiesInit()` using the desired config. -The shorthand `cxPropertiesInitDefault()` creates a default configuration with the equals sign `'='` as delimiter +The shorthand `cxPropertiesInitDefault()` creates a default configuration with the equals sign `'='` as delimiter and the hash-symbol `'#'` as comment symbol (the other two comment symbols remain unused in the default config). > In a future UCX version, the default `continuation` character will be a backslash `'\'`. @@ -87,7 +87,7 @@ but the last line did not contain a full key/value pair. In that case, you can call `cxPropertiesFill()` again to add more data and continue with `cxPropertiesNext()`. -Note, that adding more data to a non-empty input buffer will lead to an allocation, +Note that adding more data to a non-empty input buffer will lead to an allocation, unless you specified some stack memory with `cxPropertiesUseStack()`. The stack capacity must be large enough to contain the longest line in your data. If the internal buffer is not large enough to contain a single line, it is extended. @@ -178,7 +178,7 @@ > If it does, it could mean that the source was unable to provide all the data, or the properties data ended unexpectedly. > The most expected status code is `CX_PROPERTIES_NO_ERROR` which means that at least one key/value-pair was found. > If `cxPropertiesLoad()` returns `CX_PROPERTIES_NO_DATA` it means that the source did not provide any key/value-pair. -> There are several special status codes which are documented [below](#additional-status-codes). +> There are several special status codes that are documented [below](#additional-status-codes). ### Creating own Sources and Sinks