Get rid of lots of obsolete mentions of stat_sdb_t.

[gem5.git] / base / inifile.hh

diff --git a/base/inifile.hh b/base/inifile.hh
index 34424eb4b6b1725ed01df0d07a7d94fa0b3255cd..f67fdc7beb1a1611a2ab58c73a999065cf950601 100644 (file)
--- 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 &section, 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 &section, const std::string &entry,
                     std::string &value) const;