fix most of the doxygen warnings

This commit is contained in:
Johann Dreo 2010-11-09 11:44:28 +01:00
commit faaf13194f
42 changed files with 84 additions and 52 deletions

View file

@ -107,7 +107,7 @@ public:
Specify individual initial sigmas for each variable.
@param _bounds bounds for uniform initialization
@param _sigma initial value for the stddev
@param _vecSigma initial value for the stddev
*/
eoEsChromInit(eoRealVectorBounds& _bounds, const std::vector<double>& _vecSigma)
: eoRealInitBounded<EOT>(_bounds), uniqueSigma(_vecSigma[0]), vecSigma(_vecSigma)

View file

@ -65,7 +65,7 @@ public:
* modifies one parents in the populator
* using 2 new parents for each component!
*
* @param _pop a POPULATOR (not a simple population)
* @param _plop a POPULATOR (not a simple population)
*/
void apply(eoPopulator<EOT>& _plop)
{

View file

@ -52,7 +52,7 @@ public :
/** Constructor
@param _parser Parser to read parameters from.
@param _section Parser section for \tau-parameters.
@param _section Parser section for \f$\tau\f$-parameters.
*/
eoEsMutationInit(eoParser& _parser,
std::string _section="ES mutation parameters" ) :
@ -62,7 +62,7 @@ public :
/** Virtual destructor */
virtual ~eoEsMutationInit() {}
/** local \tau */
/** local tau */
double TauLcl(void)
{
if (TauLclParam == 0)

View file

@ -192,11 +192,11 @@ public:
/**
* (Default) Constructor.
*
* @param eval the evaluation function, needed to recompute the fitmess
* @param _eval the evaluation function, needed to recompute the fitmess
* @param _sigmaInit the initial value for uniform mutation
* @param _windowSize the size of the window for statistics
* @param _threshold the threshold (the 1/5 - 0.2)
* @param _updateFactor multiplicative update factor for sigma
* @param _threshold the threshold (the 1/5 - 0.2)
*/
eoOneFifthMutation(eoEvalFunc<EOT> & _eval, double & _sigmaInit,
unsigned _windowSize = 10, double _updateFactor=0.83,

View file

@ -43,6 +43,7 @@ template <class FitT> class eoReal: public eoVector<FitT, double>
/**
* (Default) Constructor.
* @param size Size of the std::vector
* @param value fill the vector with this value
*/
eoReal(unsigned size = 0, double value = 0.0):
eoVector<FitT, double>(size, value) {}

View file

@ -153,7 +153,7 @@ template<class EOT> class eoDetUniformMutation: public eoMonOp<EOT>
* it's there mostly for backward compatibility
*
* @param _epsilon the range for uniform nutation
* @param number of coordinate to modify
* @param _no number of coordinate to modify
*/
eoDetUniformMutation(const double& _epsilon, const unsigned& _no = 1):
homogeneous(true), bounds(eoDummyVectorNoBounds),
@ -163,7 +163,7 @@ template<class EOT> class eoDetUniformMutation: public eoMonOp<EOT>
* Constructor with bounds
* @param _bounds an eoRealVectorBounds that contains the bounds
* @param _epsilon the range for uniform nutation (to be scaled if necessary)
* @param number of coordinate to modify
* @param _no number of coordinate to modify
*/
eoDetUniformMutation(eoRealVectorBounds & _bounds,
const double& _epsilon, const unsigned& _no = 1):
@ -180,7 +180,7 @@ template<class EOT> class eoDetUniformMutation: public eoMonOp<EOT>
* Constructor with bounds and full std::vector of epsilon
* @param _bounds an eoRealVectorBounds that contains the bounds
* @param _epsilon the VECTOR of ranges for uniform mutation
* @param number of coordinate to modify
* @param _no number of coordinates to modify
*/
eoDetUniformMutation(eoRealVectorBounds & _bounds,
const std::vector<double>& _epsilon,
@ -257,7 +257,7 @@ template<class EOT> class eoSegmentCrossover: public eoQuadOp<EOT>
* (Default) Constructor.
* The bounds are initialized with the global object that says: no bounds.
*
* @param _alphaMin the amount of exploration OUTSIDE the parents
* @param _alpha the amount of exploration OUTSIDE the parents
* as in BLX-alpha notation (Eshelman and Schaffer)
* 0 == contractive application
* Must be positive
@ -268,7 +268,7 @@ template<class EOT> class eoSegmentCrossover: public eoQuadOp<EOT>
/**
* Constructor with bounds
* @param _bounds an eoRealVectorBounds that contains the bounds
* @param _alphaMin the amount of exploration OUTSIDE the parents
* @param _alpha the amount of exploration OUTSIDE the parents
* as in BLX-alpha notation (Eshelman and Schaffer)
* 0 == contractive application
* Must be positive
@ -348,7 +348,7 @@ template<class EOT> class eoHypercubeCrossover: public eoQuadOp<EOT>
* (Default) Constructor.
* The bounds are initialized with the global object that says: no bounds.
*
* @param _alphaMin the amount of exploration OUTSIDE the parents
* @param _alpha the amount of exploration OUTSIDE the parents
* as in BLX-alpha notation (Eshelman and Schaffer)
* 0 == contractive application
* Must be positive
@ -363,7 +363,7 @@ template<class EOT> class eoHypercubeCrossover: public eoQuadOp<EOT>
/**
* Constructor with bounds
* @param _bounds an eoRealVectorBounds that contains the bounds
* @param _alphaMin the amount of exploration OUTSIDE the parents
* @param _alpha the amount of exploration OUTSIDE the parents
* as in BLX-alpha notation (Eshelman and Schaffer)
* 0 == contractive application
* Must be positive
@ -483,7 +483,7 @@ template<class EOT> class eoRealUXover: public eoQuadOp<EOT>
* Uniform crossover for real std::vectors
* @param _eo1 The first parent
* @param _eo2 The second parent
* @std::runtime_error if sizes don't match
* @exception std::runtime_error if sizes don't match
*/
bool operator()(EOT& _eo1, EOT& _eo2)
{

View file

@ -54,7 +54,7 @@ template<class EOT> class eoSBXCrossover: public eoQuadOp<EOT>
/**
* Constructor with bounds
* @param _bounds an eoRealVectorBounds that contains the bounds
* @param _alphaMin the amount of exploration OUTSIDE the parents
* @param _eta the amount of exploration OUTSIDE the parents
* as in BLX-alpha notation (Eshelman and Schaffer)
* 0 == contractive application
* Must be positive