X-Git-Url: https://vaikene.ee/gitweb/gitweb.cgi?a=blobdiff_plain;f=src%2Flibs%2FCommon%2Finifile.h;h=5392984dfec8645a9b07bea97a214d699ccbbab9;hb=f01d61fb753b347bbff2ffb7f224650ac3f9d81e;hp=705bd9bc20795315745fef623bed1fada65005cf;hpb=555fa9e86134fda6e631e9178e50b444b1079e4f;p=evaf

diff --git a/src/libs/Common/inifile.h b/src/libs/Common/inifile.h
index 705bd9b..5392984 100644
--- a/src/libs/Common/inifile.h
+++ b/src/libs/Common/inifile.h
@@ -43,7 +43,7 @@ namespace Internal {
  * 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:
+ * This is a sample INI %file:
  * @code
  * [main]
  * # The full name of this parameter is 'main/name'
@@ -105,7 +105,7 @@ public:
      * @return The value from the INI file or an invalid QVariant if failed
      *
      * The getValue() method reads a parameter value from the INI file. Parameters are identified by a section and key name pair
-     * in the format '<section>/<key&gt'. For example, if the section is called 'general' and the key is called 'log_level',
+     * in the format '\<section\>/\<key\>'. For example, if the section is called 'general' and the key is called 'log_level',
      * then the name of the parameter should be given as 'general/log_level'. Parameter names are case insensitive.
      *
      * If the parameter cannot be read because it is not found in the INI file or the INI file object is invalid, returns the
@@ -116,6 +116,8 @@ public:
      * @li If the value in the INI file is 'abc' and the default value an integer value, then validation
      * fails and the method returns the default value;
      * @li If the default value is a boolean value, then the method accepts '1', 'true', 'on' and 'yes' as valid values.
+     *
+     * @sa eVaf::Common::toVariant()
      */
     QVariant getValue(QString const & paramName, QVariant const & defaultValue = QVariant::Invalid);
 
@@ -126,7 +128,7 @@ public:
      * @return True if succeeded and false if not
      *
      * The setValue() method writes a parameter value to the INI file. Parameters are identified by a section and key name pair
-     * in the format '&lt;section&gt;/&lt;key&gt;'. For example, if the section is called 'general' and the key is called 'log_level',
+     * in the format '\<section\>/\<key\>'. For example, if the section is called 'general' and the key is called 'log_level',
      * the the name of the parameter should be given as 'general/log_level'. Parameter names are case insensitive.
      *
      * The method returns true if the parameter value was written into the INI file and false if not. Use the errorString() method