fix some doxygen warnings

This commit is contained in:
Johann Dreo 2010-11-07 23:43:58 +01:00
commit b7009822a5
10 changed files with 26 additions and 24 deletions

View file

@ -120,21 +120,21 @@ public:
}
/** get minimum value
* @std::exception if does not exist
* std::exception if does not exist
*/
virtual long int minimum() const = 0 ;
/** get maximum value
* @std::exception if does not exist
* std::exception if does not exist
*/
virtual long int maximum() const = 0 ;
/** get range
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual long int range() const = 0;
/** random generator of uniform numbers in bounds
* uses same naming convention than eo::rng
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual double uniform(eoRng & _rng = eo::rng) const = 0;
virtual long int random(eoRng & _rng = eo::rng) const = 0;
@ -672,25 +672,25 @@ public:
virtual void truncate(double & _x) const {return repBound->truncate(_x);}
/** get minimum value
* @std::exception if does not exist
* std::exception if does not exist
*/
virtual long int minimum() const {return repBound->minimum();}
/** get maximum value
* @std::exception if does not exist
* std::exception if does not exist
*/
virtual long int maximum() const {return repBound->maximum();}
/** get range
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual long int range() const {return repBound->range();}
/** random generator of uniform doubles in bounds
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual double uniform(eoRng & _rng = eo::rng) const {(void)_rng; return repBound->uniform();}
/** random generator of uniform ints in bounds
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual long int random(eoRng & _rng = eo::rng) const {(void)_rng; return repBound->random();}

View file

@ -155,7 +155,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 _required If it is a necessary parameter or not
*/
eoValueParam(ValueType _defaultValue,

View file

@ -117,20 +117,20 @@ public:
virtual void truncate(double &) const = 0;
/** get minimum value
* @std::exception if does not exist
* std::exception if does not exist
*/
virtual double minimum() const = 0 ;
/** get maximum value
* @std::exception if does not exist
* std::exception if does not exist
*/
virtual double maximum() const = 0 ;
/** get range
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual double range() const = 0;
/** random generator of uniform numbers in bounds
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual double uniform(eoRng & _rng = eo::rng) const = 0;
@ -634,20 +634,20 @@ public:
virtual void truncate(double & _x) const {return repBound->truncate(_x);}
/** get minimum value
* @std::exception if does not exist
* std::exception if does not exist
*/
virtual double minimum() const {return repBound->minimum();}
/** get maximum value
* @std::exception if does not exist
* std::exception if does not exist
*/
virtual double maximum() const {return repBound->maximum();}
/** get range
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual double range() const {return repBound->range();}
/** random generator of uniform numbers in bounds
* @std::exception if unbounded
* std::exception if unbounded
*/
virtual double uniform(eoRng & _rng = eo::rng) const {(void)_rng; return repBound->uniform();}