diff options
Diffstat (limited to 'base')
| -rw-r--r-- | base/inifile.hh | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/base/inifile.hh b/base/inifile.hh index 34424eb4b..f67fdc7be 100644 --- a/base/inifile.hh +++ b/base/inifile.hh @@ -36,10 +36,11 @@ #include "base/hashmap.hh" -/// -/// @file -/// Declaration of IniFile object. -/// +/** + * @file + * Declaration of IniFile object. + * @todo Change comments to match documentation style. + */ /// /// This class represents the contents of a ".ini" file. @@ -192,10 +193,18 @@ class IniFile /// Find value corresponding to given section and entry names, /// following "default" links to other sections where possible. /// Value is returned by reference in 'value' param. - /// @retval True if found, false if not. + /// @return True if found, false if not. bool findDefault(const std::string §ion, const std::string &entry, std::string &value) const; + /** + * Find a value corresponding to the given section and entry names + * following "append" links to other sections where possible. + * @param section The section to start with. + * @param entry The entry to find. + * @param value The value found. + * @return True if the entry was found. + */ bool findAppend(const std::string §ion, const std::string &entry, std::string &value) const; |