summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErik Hallnor <ehallnor@umich.edu>2003-10-29 16:25:23 -0500
committerErik Hallnor <ehallnor@umich.edu>2003-10-29 16:25:23 -0500
commitb45a0808aaa26176e094e98a0cde9ec7de5f290b (patch)
tree32a54843a5542c6b9205ec463daa590bcd07a898
parent31342830fff9f13095e228686252e641181ba3df (diff)
parent5c8423b5dd7accd3d9480136055572ea7bf9b8b3 (diff)
downloadgem5-b45a0808aaa26176e094e98a0cde9ec7de5f290b.tar.xz
Merge ehallnor@zizzer:/bk/m5 into zazzer.eecs.umich.edu:/z/ehallnor/m5
--HG-- extra : convert_revision : 9497a4015940e7fb7151e09f70e84134458ee877
-rw-r--r--base/inifile.hh19
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 &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;