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
This commit is contained in:
Erik Hallnor 2003-10-14 01:20:26 -04:00
parent 551e67d3d6
commit af35f423ba
2 changed files with 732 additions and 103 deletions

View file

@ -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;
};

File diff suppressed because it is too large Load diff