X-Git-Url: https://vaikene.ee/gitweb/pswgen11.html?a=blobdiff_plain;f=src%2Flibs%2FCommon%2Ficonfig.h;h=83fe3f11550309a40e8db02e17fca5ea45f3de0f;hb=13dedf19c628b9967e4c4106ab0fd967f1df0b90;hp=3157eb69673aedc095be6ac874fd32ecd704051c;hpb=ec272061c2af46e4cd8730c18682e18ac5b369ff;p=evaf
diff --git a/src/libs/Common/iconfig.h b/src/libs/Common/iconfig.h
index 3157eb6..83fe3f1 100644
--- a/src/libs/Common/iconfig.h
+++ b/src/libs/Common/iconfig.h
@@ -3,7 +3,7 @@
* @brief eVaf configuration interface
* @author Enar Vaikene
*
- * Copyright (c) 2011 Enar Vaikene
+ * Copyright (c) 2011-2019 Enar Vaikene
*
* This file is part of the eVaf C++ cross-platform application development framework.
*
@@ -36,11 +36,11 @@ namespace Common {
* The iConfig interface provides access to configuration parameters. Methods in this interface can be
* used to read and write configuration parameters.
*
- * The default implementation of the iConfig interface uses INI files in the eVaf::Common::iApp::instance()->etcDir()
+ * The default implementation of the iConfig interface uses INI files in the eVaf::Common::iApp::etcDir()
* directory. Additional configuration backends can be provided by re-implementing the interface.
*
* Configuration parameters are identified by a name in the following format:
- * [\][\]/\/\
+ * @verbatim [][]// @endverbatim
*
* Where:
* @li \ is an optional identifier for the configuration backend. This part is ignored by the default
@@ -48,11 +48,11 @@ namespace Common {
* for the 'db:' backend identifier and store parameters in a database. Any other requests would be forwarded to
* the default implementation.
* @li \ is an optional configuration file name. The default iConfig interface implementation uses the file
- * name part to locate the INI file in the eVaf::Common::iApp::instance()->etcDir() directory. If the file name part
- * is '*' or empty, uses eVaf::Common::iApp::instance()->name() for the file name.
+ * name part to locate the INI file in the eVaf::Common::iApp::etcDir() directory. If the file name part
+ * is '*' or empty, uses eVaf::Common::iApp::name() for the file name.
* @li \ is the name of the section. Section names can contain extra '/' characters to build a structured
* tree of configuration sections.
- * @li \ is the name of the key.
+ * @li \ is the name of the parameter.
*
* For example:
* @li 'db:local/extensions/help/module' - backend 'db:', file or database name 'local', section name 'extensions/help' and
@@ -77,7 +77,8 @@ public:
*
* This method returns the current iConfig interface instance as shown in the following example:
* @code
- * QString moduleName = eVaf::Common::iConfig::instance()->getValue("/extensions/help/module", "libHelp.so").toString();
+ * QString moduleName =
+ * eVaf::Common::iConfig::instance()->getValue("/extensions/help/module", "libHelp.so").toString();
* @endcode
*/
static iConfig * instance();