changeset 71:7db18b322fba

Update comment
author daedric <d43dr1c@gmail.com>
date Wed, 31 Mar 2010 17:03:16 +0200
parents dda89f1d48c6
children d9a923a961e7
files include/IConfig.hpp
diffstat 1 files changed, 10 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/include/IConfig.hpp	Wed Mar 31 17:00:43 2010 +0200
+++ b/include/IConfig.hpp	Wed Mar 31 17:03:16 2010 +0200
@@ -26,6 +26,16 @@
              * complex data structure is required.
              *
              * @return the map of key/value found in configuration file.
+             * the first level represent the section of the configuration.
+             *
+             * For example:
+             * <global>
+             * <key>value</key>
+             * </global>
+             *
+             * ValueMap[global] => std::multimap<string, string>
+             * ValueMap[global][key] -> iterator on all value for key 'key'
+             *
              */
             virtual const ValueMap &    getEntries(void) const = 0;
         };