From b7009822a5bfbbe73a735c43fb2c66f49feebd89 Mon Sep 17 00:00:00 2001 From: Johann Dreo Date: Sun, 7 Nov 2010 23:43:58 +0100 Subject: [PATCH] fix some doxygen warnings --- eo/src/eoAlgo.h | 2 +- eo/src/eoConstrictedVariableWeightVelocity.h | 2 +- eo/src/eoConstrictedVelocity.h | 2 +- eo/src/eoFunctor.h | 2 +- eo/src/eoSelectOne.h | 2 +- eo/src/ga/eoBit.h | 1 + eo/src/ga/eoBitOp.h | 3 ++- eo/src/utils/eoIntBounds.h | 18 +++++++++--------- eo/src/utils/eoParam.h | 2 +- eo/src/utils/eoRealBounds.h | 16 ++++++++-------- 10 files changed, 26 insertions(+), 24 deletions(-) diff --git a/eo/src/eoAlgo.h b/eo/src/eoAlgo.h index 8201d5963..494b7b76c 100644 --- a/eo/src/eoAlgo.h +++ b/eo/src/eoAlgo.h @@ -35,7 +35,7 @@ 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, - 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. */ diff --git a/eo/src/eoConstrictedVariableWeightVelocity.h b/eo/src/eoConstrictedVariableWeightVelocity.h index 64139ea59..fd0dc13b6 100644 --- a/eo/src/eoConstrictedVariableWeightVelocity.h +++ b/eo/src/eoConstrictedVariableWeightVelocity.h @@ -60,7 +60,7 @@ public: * @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. * 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 */ eoConstrictedVariableWeightVelocity (eoTopology < POT > & _topology, diff --git a/eo/src/eoConstrictedVelocity.h b/eo/src/eoConstrictedVelocity.h index d71e29b05..bd68f0425 100644 --- a/eo/src/eoConstrictedVelocity.h +++ b/eo/src/eoConstrictedVelocity.h @@ -60,7 +60,7 @@ public: * @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. * 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 */ eoConstrictedVelocity (eoTopology < POT > & _topology, diff --git a/eo/src/eoFunctor.h b/eo/src/eoFunctor.h index 17cbaca56..50c136642 100644 --- a/eo/src/eoFunctor.h +++ b/eo/src/eoFunctor.h @@ -60,7 +60,7 @@ public : /// tag to identify a binary function in compile time function selection @see functor_category struct binary_function_tag {}; }; -/** @example t-eoFunctop.cpp +/** @example t-eoFunctor.cpp */ /** diff --git a/eo/src/eoSelectOne.h b/eo/src/eoSelectOne.h index f4cde80c2..3b27a4e3a 100644 --- a/eo/src/eoSelectOne.h +++ b/eo/src/eoSelectOne.h @@ -53,7 +53,7 @@ class eoSelectOne : public eoUF&, const EOT&> (void)_pop; } }; -/** @example t-eoSelectOne.cpp +/** @example t-selectOne.cpp */ diff --git a/eo/src/ga/eoBit.h b/eo/src/ga/eoBit.h index cf12e9e59..7f91b886e 100644 --- a/eo/src/ga/eoBit.h +++ b/eo/src/ga/eoBit.h @@ -71,6 +71,7 @@ public: /** * (Default) Constructor. * @param size Size of the binary std::string. + * @param value Default value. */ eoBit(unsigned size = 0, bool value = false): eoVector(size, value) {} diff --git a/eo/src/ga/eoBitOp.h b/eo/src/ga/eoBitOp.h index a1484ff19..21205a3d6 100644 --- a/eo/src/ga/eoBitOp.h +++ b/eo/src/ga/eoBitOp.h @@ -109,6 +109,7 @@ template class eoBitMutation: public eoMonOp /** * (Default) Constructor. * @param _rate Rate of mutation. + * @param _normalize use rate/chrom.size if true */ eoBitMutation(const double& _rate = 0.01, bool _normalize=false): rate(_rate), normalize(_normalize) {} @@ -289,7 +290,7 @@ template class eoUBitXover: public eoQuadOp * Uniform crossover for binary chromosomes. * @param chrom1 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) { diff --git a/eo/src/utils/eoIntBounds.h b/eo/src/utils/eoIntBounds.h index cd200b3d2..807751da4 100644 --- a/eo/src/utils/eoIntBounds.h +++ b/eo/src/utils/eoIntBounds.h @@ -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();} diff --git a/eo/src/utils/eoParam.h b/eo/src/utils/eoParam.h index 29608a18e..1eb97b306 100644 --- a/eo/src/utils/eoParam.h +++ b/eo/src/utils/eoParam.h @@ -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, diff --git a/eo/src/utils/eoRealBounds.h b/eo/src/utils/eoRealBounds.h index c8761978a..f79aac044 100644 --- a/eo/src/utils/eoRealBounds.h +++ b/eo/src/utils/eoRealBounds.h @@ -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();}