fix most of the doxygen warnings
This commit is contained in:
parent
22224ad793
commit
faaf13194f
42 changed files with 84 additions and 52 deletions
|
|
@ -55,6 +55,7 @@ public :
|
|||
* @param _delim delimiter string to use between each item of the registered vector (e.g. of eoStats)
|
||||
* @param _keep_existing if true, overwrite any existing file with the same name prior to any output
|
||||
* @param _header print the header (with the descriptions of registered eoStats) at the beginning of the file (WARNING: true will discards header printing)
|
||||
* @param _overwrite if true, overwrite the existing file
|
||||
*/
|
||||
eoFileMonitor(
|
||||
std::string _filename,
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ public:
|
|||
/** Open pipe to Gnuplot.
|
||||
|
||||
@param _title Title for gnuplot window.
|
||||
@param _extra Extra parameters to gnuplot (default <none>).
|
||||
@param _extra Extra parameters to gnuplot (default to none: "").
|
||||
*/
|
||||
eoGnuplot(std::string _title, std::string _extra = std::string(""));
|
||||
|
||||
|
|
|
|||
|
|
@ -77,7 +77,7 @@ class eoHowMany : public eoPersistent
|
|||
{
|
||||
public:
|
||||
/** Original Ctor from direct rate + bool
|
||||
@param rate the rate, OR the integer to store, depending on 2nd arg.
|
||||
@param _rate the rate, OR the integer to store, depending on 2nd arg.
|
||||
@param _interpret_as_rate to tell whether the rate actually is a rate
|
||||
*/
|
||||
eoHowMany(double _rate = 0.0, bool _interpret_as_rate = true):
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ public :
|
|||
* @param _defaultValue The default value
|
||||
* @param _longName Long name of the argument
|
||||
* @param _description Description of the parameter. What is useful for.
|
||||
* @param _shortName Short name of the argument (Optional)
|
||||
* @param _shortHand Short name of the argument (Optional)
|
||||
* @param _section Name of the section where the parameter belongs
|
||||
* @param _required If it is a necessary parameter or not
|
||||
*/
|
||||
|
|
@ -128,8 +128,14 @@ public:
|
|||
*/
|
||||
void processParam(eoParam& param, std::string section = "");
|
||||
|
||||
/** Read from a stream
|
||||
* @param is the input stream
|
||||
*/
|
||||
void readFrom(std::istream& is);
|
||||
|
||||
/** Pint on a stream
|
||||
* @param os the output stream
|
||||
*/
|
||||
void printOn(std::ostream& os) const;
|
||||
|
||||
/// className for readibility
|
||||
|
|
@ -207,7 +213,7 @@ public:
|
|||
@param _defaultValue Default value.
|
||||
@param _longName Long name of the argument.
|
||||
@param _description Description of the parameter.
|
||||
@param _shortName Short name of the argument (Optional)
|
||||
@param _shortHand Short name of the argument (Optional)
|
||||
@param _section Name of the section where the parameter belongs.
|
||||
@param _required Is the parameter mandatory?
|
||||
@return Corresponding parameter.
|
||||
|
|
|
|||
|
|
@ -305,7 +305,7 @@ public:
|
|||
|
||||
/**
|
||||
* Read object from a std::string
|
||||
* @param _is A std::istream.
|
||||
* @param _s A std::istream.
|
||||
*/
|
||||
virtual void readFrom(std::string _s) ;
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@
|
|||
An eoStat that simply gives the user time since first generation
|
||||
It has to be tempatized by EOT because it must be an eoStat
|
||||
|
||||
@group Stats
|
||||
@ingroup Stats
|
||||
*/
|
||||
class eoTimeCounter : public eoUpdater, public eoValueParam<double>
|
||||
{
|
||||
|
|
|
|||
Reference in a new issue