Mercurial > hg > ucx / file diff

--- a/docs/Writerside/topics/properties.h.md	Wed Feb 26 23:01:27 2025 +0100
+++ b/docs/Writerside/topics/properties.h.md	Thu Feb 27 14:07:59 2025 +0100
@@ -1,11 +1,33 @@
 # Properties
 
-The UCX properties parser can be used to parse line-separated key/value strings. 
+The UCX properties parser can be used to parse line based key/value strings. 
 
 <warning>
 New Feature - documentation work in progress!
 </warning>
 
+## Supported Syntax
+
+Key/value pairs must be line based and separated by a single character delimter.
+The parser supports up to three different characters which introduce comments.
+All characters starting with a comment character up to the end of the line are ignored.
+Blank lines are also ignored.
+
+An example properties file looks like this:
+
+```properties
+# Comment line at start of file
+key1 = value1
+key2 = value2
+# next is a blank line and will be ignored
+
+  keys_are_trimmed  =    and_so_are_values   # also a comment
+```
+
+> Delimiter and comment characters are configured with the  `CxPropertiesConfig` structure.
+> There is also a field reserved for `continuation` which will be used as a line continuation character
+> in a future version of UCX.
+> In UCX 3.1 this is not implemented.
 
 ## Basic Parsing