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

@ -35,7 +35,7 @@
problem as arguments, and iteratively modify them with the help of operators. problem as arguments, and iteratively modify them with the help of operators.
Generally, an EO object is built by assembling together @ref Operators in an algorithm instance, Generally, an EO object is built by assembling together @ref Operators in an algorithm instance,
and then calling the algorithm's operator() on an initial @ref Population. The algorithm will then and then calling the algorithm's operator() on an initial population (an eoPop). The algorithm will then
manipulate the solutions within the population to search for the problem's optimum. manipulate the solutions within the population to search for the problem's optimum.
*/ */

View file

@ -60,7 +60,7 @@ public:
* @param _c2 - The second learning factor used for the local/global best(s). Type must be POT::ParticleVelocityType * @param _c2 - The second learning factor used for the local/global best(s). Type must be POT::ParticleVelocityType
* @param _bounds - An eoRealBaseVectorBounds: real bounds for real velocities. * @param _bounds - An eoRealBaseVectorBounds: real bounds for real velocities.
* If the velocities are not real, they won't be bounded by default. Should have a eoBounds ? * If the velocities are not real, they won't be bounded by default. Should have a eoBounds ?
* @param _boundsModifier - An eoRealBoundModifier used to modify the bounds (for real bounds only). * @param _bndsModifier - An eoRealBoundModifier used to modify the bounds (for real bounds only).
* @param _gen - The eo random generator, default=rng * @param _gen - The eo random generator, default=rng
*/ */
eoConstrictedVariableWeightVelocity (eoTopology < POT > & _topology, eoConstrictedVariableWeightVelocity (eoTopology < POT > & _topology,

View file

@ -60,7 +60,7 @@ public:
* @param _c2 - The second learning factor used for the local/global best(s). Type must be POT::ParticleVelocityType * @param _c2 - The second learning factor used for the local/global best(s). Type must be POT::ParticleVelocityType
* @param _bounds - An eoRealBaseVectorBounds: real bounds for real velocities. * @param _bounds - An eoRealBaseVectorBounds: real bounds for real velocities.
* If the velocities are not real, they won't be bounded by default. Should have a eoBounds ? * If the velocities are not real, they won't be bounded by default. Should have a eoBounds ?
* @param _boundsModifier - An eoRealBoundModifier used to modify the bounds (for real bounds only). * @param _bndsModifier - An eoRealBoundModifier used to modify the bounds (for real bounds only).
* @param _gen - The eo random generator, default=rng * @param _gen - The eo random generator, default=rng
*/ */
eoConstrictedVelocity (eoTopology < POT > & _topology, eoConstrictedVelocity (eoTopology < POT > & _topology,

View file

@ -60,7 +60,7 @@ public :
/// tag to identify a binary function in compile time function selection @see functor_category /// tag to identify a binary function in compile time function selection @see functor_category
struct binary_function_tag {}; struct binary_function_tag {};
}; };
/** @example t-eoFunctop.cpp /** @example t-eoFunctor.cpp
*/ */
/** /**

View file

@ -53,7 +53,7 @@ class eoSelectOne : public eoUF<const eoPop<EOT>&, const EOT&>
(void)_pop; (void)_pop;
} }
}; };
/** @example t-eoSelectOne.cpp /** @example t-selectOne.cpp
*/ */

View file

@ -71,6 +71,7 @@ public:
/** /**
* (Default) Constructor. * (Default) Constructor.
* @param size Size of the binary std::string. * @param size Size of the binary std::string.
* @param value Default value.
*/ */
eoBit(unsigned size = 0, bool value = false): eoBit(unsigned size = 0, bool value = false):
eoVector<FitT, bool>(size, value) {} eoVector<FitT, bool>(size, value) {}

View file

@ -109,6 +109,7 @@ template<class Chrom> class eoBitMutation: public eoMonOp<Chrom>
/** /**
* (Default) Constructor. * (Default) Constructor.
* @param _rate Rate of mutation. * @param _rate Rate of mutation.
* @param _normalize use rate/chrom.size if true
*/ */
eoBitMutation(const double& _rate = 0.01, bool _normalize=false): eoBitMutation(const double& _rate = 0.01, bool _normalize=false):
rate(_rate), normalize(_normalize) {} rate(_rate), normalize(_normalize) {}
@ -289,7 +290,7 @@ template<class Chrom> class eoUBitXover: public eoQuadOp<Chrom>
* Uniform crossover for binary chromosomes. * Uniform crossover for binary chromosomes.
* @param chrom1 The first chromosome. * @param chrom1 The first chromosome.
* @param chrom2 The first chromosome. * @param chrom2 The first chromosome.
* @std::runtime_error if sizes don't match * std::runtime_error if sizes don't match
*/ */
bool operator()(Chrom& chrom1, Chrom& chrom2) bool operator()(Chrom& chrom1, Chrom& chrom2)
{ {

View file

@ -120,21 +120,21 @@ public:
} }
/** get minimum value /** get minimum value
* @std::exception if does not exist * std::exception if does not exist
*/ */
virtual long int minimum() const = 0 ; virtual long int minimum() const = 0 ;
/** get maximum value /** get maximum value
* @std::exception if does not exist * std::exception if does not exist
*/ */
virtual long int maximum() const = 0 ; virtual long int maximum() const = 0 ;
/** get range /** get range
* @std::exception if unbounded * std::exception if unbounded
*/ */
virtual long int range() const = 0; virtual long int range() const = 0;
/** random generator of uniform numbers in bounds /** random generator of uniform numbers in bounds
* uses same naming convention than eo::rng * 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 double uniform(eoRng & _rng = eo::rng) const = 0;
virtual long int random(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);} virtual void truncate(double & _x) const {return repBound->truncate(_x);}
/** get minimum value /** get minimum value
* @std::exception if does not exist * std::exception if does not exist
*/ */
virtual long int minimum() const {return repBound->minimum();} virtual long int minimum() const {return repBound->minimum();}
/** get maximum value /** get maximum value
* @std::exception if does not exist * std::exception if does not exist
*/ */
virtual long int maximum() const {return repBound->maximum();} virtual long int maximum() const {return repBound->maximum();}
/** get range /** get range
* @std::exception if unbounded * std::exception if unbounded
*/ */
virtual long int range() const {return repBound->range();} virtual long int range() const {return repBound->range();}
/** random generator of uniform doubles in bounds /** 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();} virtual double uniform(eoRng & _rng = eo::rng) const {(void)_rng; return repBound->uniform();}
/** random generator of uniform ints in bounds /** 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();} 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 _defaultValue The default value
* @param _longName Long name of the argument * @param _longName Long name of the argument
* @param _description Description of the parameter. What is useful for. * @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 * @param _required If it is a necessary parameter or not
*/ */
eoValueParam(ValueType _defaultValue, eoValueParam(ValueType _defaultValue,

View file

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