summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorErik Hallnor <ehallnor@umich.edu>2003-10-29 16:25:08 -0500
committerErik Hallnor <ehallnor@umich.edu>2003-10-29 16:25:08 -0500
commit5c8423b5dd7accd3d9480136055572ea7bf9b8b3 (patch)
tree32a54843a5542c6b9205ec463daa590bcd07a898
parent034babf0fad03f9a8bfde171437c0f0cc9bf72d6 (diff)
downloadgem5-5c8423b5dd7accd3d9480136055572ea7bf9b8b3.tar.xz
Clear up doxygen warnings and serialize ScsiCtrl. We probably shouldn't decfine functions using type defs ala "RegFile" instead of "AlphaISA::RegFile".
base/inifile.hh: Document findAppend --HG-- extra : convert_revision : ab5047590b3ca2a9126b75351e4902d300b5b5ad
-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;