* @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.
*
* 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:
- * [\<backend:\>][\<file\>]/\<section\>/\<key\>
+ * @verbatim [<backend:>][<file>]/<section>/<key> @endverbatim
*
* Where:
* @li \<backend:\> is an optional identifier for the configuration backend. This part is ignored by the default
* for the 'db:' backend identifier and store parameters in a database. Any other requests would be forwarded to
* the default implementation.
* @li \<file\> 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 \<section\> is the name of the section. Section names can contain extra '/' characters to build a structured
* tree of configuration sections.
- * @li \<key\> is the name of the key.
+ * @li \<key\> 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
*
* 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();