X-Git-Url: https://vaikene.ee/gitweb/highlight.css?a=blobdiff_plain;f=src%2Flibs%2FCommon%2Finifile.h;h=705bd9bc20795315745fef623bed1fada65005cf;hb=555fa9e86134fda6e631e9178e50b444b1079e4f;hp=b795e6a9435dc02dfc222c7af964094b93649801;hpb=6230ebd0a05134031e52001c15473c3c3e6c7c1b;p=evaf

diff --git a/src/libs/Common/inifile.h b/src/libs/Common/inifile.h
index b795e6a..705bd9b 100644
--- a/src/libs/Common/inifile.h
+++ b/src/libs/Common/inifile.h
@@ -35,12 +35,25 @@ namespace Internal {
 /**
  * Class for reading and writing parameter values in INI files.
  *
- * The IniFile class provides access to parameter values in a standard INI file. Every parameter value is
- * identified by a section/key name pair. Key names can be prefixed with 'windows:' or 'linux:' if the
- * parameter value is specific for the given platform. This allows entering platform-specific parameter
- * values to the INI file. INI files can contain comment lines that start with ';' or '#'. Comments are
+ * The IniFile class provides access to parameter values in a standard INI file.
+ * Every parameter value is identified by a section/key name pair. Key names can be prefixed with
+ * 'windows:' or 'linux:' if the parameter value is specific for the given platform.
+ * This allows entering platform-specific parameter values to the INI file.
+ *
+ * INI files can contain comment lines that start with ';' or '#'. Comments are
  * preserved when new values are written to the INI file.
  *
+ * This is a sample INI file:
+ * @code
+ * [main]
+ * # The full name of this parameter is 'main/name'
+ * name = MyApplication
+ *
+ * [extensions/about]
+ * # The full name of this parameter is 'extensions/about/module'
+ * module = libabout.so
+ * @endcode
+ *
  * Values in INI files are stored as strings and the IniFile class expects them to use specific formats if
  * the returned value is supposed to be of a different data type. The following list shows the expected format
  * of different data types: