diff options
author | Erik Hallnor <ehallnor@umich.edu> | 2003-10-14 01:20:26 -0400 |
---|---|---|
committer | Erik Hallnor <ehallnor@umich.edu> | 2003-10-14 01:20:26 -0400 |
commit | af35f423ba4b24e6b9317313e90a730ce7f187ae (patch) | |
tree | 9a022dbf636ad40e5a1d985ec020b45938f0e6bb /base/statistics.cc | |
parent | 551e67d3d6108eaf2168fc37267c1da6e888aa0f (diff) | |
download | gem5-af35f423ba4b24e6b9317313e90a730ce7f187ae.tar.xz |
Since I seem to be bug compatible with the head I'm going to commit.
There is still one documentation warning in the stat code, probably a
doxygen error.
base/statistics.cc:
Added documentation to SubData and StatData.
base/statistics.hh:
Documented most of the basic stats (storage, implemenation) and all of the
visible stats. There is more to be documented, but I'm going crazy now.
Also fixed the DistStor::zero() function to meet the semantics of the other ones.
--HG--
extra : convert_revision : f80b3075a3298cbded059be8125b7fc7b77020a9
Diffstat (limited to 'base/statistics.cc')
-rw-r--r-- | base/statistics.cc | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/base/statistics.cc b/base/statistics.cc index 7c88e8f64..abebcae53 100644 --- a/base/statistics.cc +++ b/base/statistics.cc @@ -67,24 +67,46 @@ namespace Statistics { bool PrintDescriptions = true; namespace Detail { +/** + * Struct to contain a name and description of statistic subfield. + */ struct SubData { + /** Subfield name. */ string name; + /** Subfield desc. */ string desc; }; +/** + * Struct to contain print data of a Stat. + */ struct StatData { + /** + * Create this struct. + */ StatData(); + /** + * Destructor. + */ ~StatData(); + /** True if the stat has been initialized. */ bool init; + /** True if the stat should be printed. */ bool print; + /** The name of the stat. */ string name; + /** Names and descriptions of subfields. */ vector<SubData> *subdata; + /** The description of the stat. */ string desc; + /** The display precision. */ int precision; + /** The formatting flags. */ FormatFlags flags; + /** A pointer to a prerequisite Stat. */ const Stat *prereq; }; |