Numeric character and character entity references are now also supported when convert...

[evaf] / src / libs / Common / inifile.h

diff --git a/src/libs/Common/inifile.h b/src/libs/Common/inifile.h
index 2ebe1c1c863c4ec340443e9d271900cb9f844453..ecf873768a37ff0b51413fcb5596ca347d334217 100644 (file)
--- a/src/libs/Common/inifile.h
+++ b/src/libs/Common/inifile.h
@@ -47,7 +47,10 @@ namespace Internal {
  * @code
  * [main]
  * # The full name of this parameter is 'main/name'
- * name = MyApplication
+ * name = "My Application"
+ *
+ * # 4-byte binary version number 1.0.7.10 with the name 'main/version'
+ * version = �

  *
  * [extensions/about]
  * # The full name of this parameter is 'extensions/about/module'
@@ -66,7 +69,14 @@ namespace Internal {
  * @li Int - only base 10 (decimal) is allowed;
  * @li Time - 24h time string in the format HH:MM:SS
  * @li UInt - base 16 (hex) if the string is prefixed with '0x'; base 8 if the string starts with '0'; otherwise
- * the value is expected to be base 10 (decimal).
+ * the value is expected to be base 10 (decimal);
+ * @li ByteArray - non-printable bytes and special characters are encoded as numeric character or character entity references;
+ * @li String - non-printable and special characters are encoded as numeric character or character entity references.
+ *
+ * Strings and Byte array values can be enclosed in single or double quotes. The IniFile class does this automatically when
+ * saving String or Byte array values with leading or trailing spaces. Quotes are removed from the parameter value prior
+ * returning the value to the application. Use character entity references """ and "'" if quotes should be part of
+ * the parameter value.
  */
 class COMMON_EXPORT IniFile
 {