From faaf13194f5f0851a1ee2189a09522e55d9e33d6 Mon Sep 17 00:00:00 2001 From: Johann Dreo Date: Tue, 9 Nov 2010 11:44:28 +0100 Subject: [PATCH] fix most of the doxygen warnings --- eo/src/eoContinue.h | 6 ++++++ eo/src/eoFixedInertiaWeightedVelocity.h | 2 +- eo/src/eoGenContinue.h | 6 ++++++ eo/src/eoInit.h | 2 +- eo/src/eoInitializer.h | 2 ++ eo/src/eoInt.h | 1 + eo/src/eoIntegerVelocity.h | 3 ++- eo/src/eoLinearTopology.h | 2 +- eo/src/eoOneToOneBreeder.h | 1 - eo/src/eoOpSelMason.h | 2 +- eo/src/eoOrderXover.h | 2 ++ eo/src/eoParticleFullInitializer.h | 2 ++ eo/src/eoPop.h | 4 ++-- eo/src/eoPrintable.h | 2 +- eo/src/eoReduceMerge.h | 7 ++++--- eo/src/eoRingTopology.h | 2 -- eo/src/eoSGATransform.h | 4 ++-- eo/src/eoSecondsElapsedContinue.h | 6 ++++++ eo/src/eoSharingSelect.h | 3 ++- eo/src/eoShiftMutation.h | 2 +- eo/src/eoSimpleEDA.h | 4 ++-- eo/src/eoStandardVelocity.h | 2 +- eo/src/eoStarTopology.h | 2 -- eo/src/eoTruncatedSelectOne.h | 4 ++-- eo/src/eoTwoOptMutation.h | 2 +- eo/src/es/eoEsChromInit.h | 2 +- eo/src/es/eoEsGlobalXover.h | 2 +- eo/src/es/eoEsMutationInit.h | 4 ++-- eo/src/es/eoNormalMutation.h | 4 ++-- eo/src/es/eoReal.h | 1 + eo/src/es/eoRealOp.h | 16 ++++++++-------- eo/src/es/eoSBXcross.h | 2 +- eo/src/gp/eoParseTreeDepthInit.h | 2 +- eo/src/gp/eoParseTreeOp.h | 2 +- eo/src/gp/eoStParseTreeDepthInit.h | 5 +++-- eo/src/gp/eoStParseTreeOp.h | 2 +- eo/src/utils/eoFileMonitor.h | 1 + eo/src/utils/eoGnuplot.h | 2 +- eo/src/utils/eoHowMany.h | 2 +- eo/src/utils/eoParser.h | 10 ++++++++-- eo/src/utils/eoRealVectorBounds.h | 2 +- eo/src/utils/eoTimeCounter.h | 2 +- 42 files changed, 84 insertions(+), 52 deletions(-) diff --git a/eo/src/eoContinue.h b/eo/src/eoContinue.h index c49e8c95..98321512 100644 --- a/eo/src/eoContinue.h +++ b/eo/src/eoContinue.h @@ -50,11 +50,17 @@ class eoContinue : public eoUF&, bool>, public eoPersistent public: virtual std::string className(void) const { return "eoContinue"; } + /** Read from a stream + * @param __is istream to read from + */ void readFrom (std :: istream & __is) { (void)__is; /* It should be implemented by subclasses ! */ } + /** Print on a stream + * @param __os ostream to print on + */ void printOn (std :: ostream & __os) const { (void)__os; /* It should be implemented by subclasses ! */ diff --git a/eo/src/eoFixedInertiaWeightedVelocity.h b/eo/src/eoFixedInertiaWeightedVelocity.h index 26848a59..b19d36a9 100644 --- a/eo/src/eoFixedInertiaWeightedVelocity.h +++ b/eo/src/eoFixedInertiaWeightedVelocity.h @@ -58,7 +58,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 */ eoFixedInertiaWeightedVelocity (eoTopology < POT > & _topology, diff --git a/eo/src/eoGenContinue.h b/eo/src/eoGenContinue.h index 4dbdd206..05382414 100644 --- a/eo/src/eoGenContinue.h +++ b/eo/src/eoGenContinue.h @@ -86,11 +86,17 @@ public: virtual std::string className(void) const { return "eoGenContinue"; } + /** Read from a stream + * @param __is the istream to read from + */ void readFrom (std :: istream & __is) { __is >> thisGeneration; /* Loading the number of generations counted */ } + /** Print on a stream + * @param __os the ostream to print on + */ void printOn (std :: ostream & __os) const { __os << thisGeneration << std :: endl; /* Saving the number of generations counted */ diff --git a/eo/src/eoInit.h b/eo/src/eoInit.h index bfa616c2..c751b4a2 100644 --- a/eo/src/eoInit.h +++ b/eo/src/eoInit.h @@ -191,7 +191,7 @@ class eoInitPermutation: public eoInit eoInitAdaptor changes the place in the hierarchy from eoInit to eoMonOp. This is mainly a type conversion, nothing else - . + @see eoInit, eoMonOp */ template diff --git a/eo/src/eoInitializer.h b/eo/src/eoInitializer.h index d3190894..26cb61de 100644 --- a/eo/src/eoInitializer.h +++ b/eo/src/eoInitializer.h @@ -66,6 +66,7 @@ public: //! @param _proc Evaluation function //! @param _initVelo Initialization of the velocity //! @param _initBest Initialization of the best + //! @param _topology the topology to use //! @param _pop Population eoInitializer( eoUF& _proc, @@ -80,6 +81,7 @@ public: //! @param _proc Evaluation function //! @param _initVelo Initialization of the velocity //! @param _initBest Initialization of the best + //! @param _topology the topology to use //! @param _pop Population eoInitializer( eoPopEvalFunc & _proc, diff --git a/eo/src/eoInt.h b/eo/src/eoInt.h index d3eb496c..bc16728d 100644 --- a/eo/src/eoInt.h +++ b/eo/src/eoInt.h @@ -43,6 +43,7 @@ template class eoInt: public eoVector /** * (Default) Constructor. * @param size Size of the std::vector + * @param value fill the vector with this value */ eoInt(unsigned size = 0, int value = 0): eoVector(size, value) {} diff --git a/eo/src/eoIntegerVelocity.h b/eo/src/eoIntegerVelocity.h index 1802dab5..190db1b0 100644 --- a/eo/src/eoIntegerVelocity.h +++ b/eo/src/eoIntegerVelocity.h @@ -60,7 +60,7 @@ public: * @param _c3 - The third 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 */ eoIntegerVelocity (eoTopology < POT > & _topology, @@ -104,6 +104,7 @@ public: /** Constructor: Neither bounds nor bound updater required <-> free velocity + * @param _topology the topology to use * @param _c1 - The first learning factor quantify how much the particle trusts itself. Type must be POT::ParticleVelocityType * @param _c2 - The second learning factor used for the particle's best. Type must be POT::ParticleVelocityType * @param _c3 - The third learning factor used for the local/global best(s). Type must be POT::ParticleVelocityType diff --git a/eo/src/eoLinearTopology.h b/eo/src/eoLinearTopology.h index 99457b67..b7c72416 100644 --- a/eo/src/eoLinearTopology.h +++ b/eo/src/eoLinearTopology.h @@ -48,7 +48,7 @@ public: /** * Build the topology made of _neighborhoodSize neighborhoods. - * @param _neighborhoods - The size of each neighborhood. + * @param _neighborhoodSize - The size of each neighborhood. */ eoLinearTopology (unsigned _neighborhoodSize):neighborhoodSize (_neighborhoodSize),isSetup(false){} diff --git a/eo/src/eoOneToOneBreeder.h b/eo/src/eoOneToOneBreeder.h index 4036377c..2e593333 100644 --- a/eo/src/eoOneToOneBreeder.h +++ b/eo/src/eoOneToOneBreeder.h @@ -55,7 +55,6 @@ class eoOneToOneBreeder: public eoBreed /** Ctor: * @param _op a general operator (must MODIFY only ONE parent) * @param _eval an eoEvalFunc to evaluate the offspring - * @param _select a selectoOne, to be used for all selections [sequential] * @param _pReplace probability that the best of parent/offspring wins [1] * @param _howMany eoHowMany offpsring to generate [100%] */ diff --git a/eo/src/eoOpSelMason.h b/eo/src/eoOpSelMason.h index 02f92777..791b2607 100644 --- a/eo/src/eoOpSelMason.h +++ b/eo/src/eoOpSelMason.h @@ -59,7 +59,7 @@ public: Stores all operators built in a database (#allocMap#), so that somebody can destroy them later. The Mason is in charge or destroying the operators, since the built object canīt do it itself. The objects built must be destroyed - from outside, using the #destroy# method + from outside, using the "destroy" method */ virtual eoOpSelector* make(std::istream& _is) { diff --git a/eo/src/eoOrderXover.h b/eo/src/eoOrderXover.h index 234d4311..0c98990d 100644 --- a/eo/src/eoOrderXover.h +++ b/eo/src/eoOrderXover.h @@ -58,6 +58,8 @@ template class eoOrderXover: public eoQuadOp * @param _chrom2 The second parent chromosome. * @param _child The result chromosome. * @param _direction The direction of the OrderXover (left: -1 or right: 1) + * @param _cut1 index of the first cut + * @param _cut2 index of the second cut */ void cross(Chrom& _chrom1, Chrom& _chrom2, Chrom& _child, char _direction, unsigned _cut1, unsigned _cut2){ diff --git a/eo/src/eoParticleFullInitializer.h b/eo/src/eoParticleFullInitializer.h index 8ec414df..5a03bd6f 100644 --- a/eo/src/eoParticleFullInitializer.h +++ b/eo/src/eoParticleFullInitializer.h @@ -66,6 +66,7 @@ template class eoParticleInitializer : public eoInitializerBase & _proc, @@ -80,6 +81,7 @@ template class eoParticleInitializer : public eoInitializerBase & _proc, diff --git a/eo/src/eoPop.h b/eo/src/eoPop.h index 7eb726c5..5c63fb40 100644 --- a/eo/src/eoPop.h +++ b/eo/src/eoPop.h @@ -87,10 +87,10 @@ public: } }; - /** appstd::ends random guys at end of pop. + /** appends random guys at end of pop. Can be used to initialize it pop is empty - @param _popSize total population size + @param _newPopSize total population size @param _chromInit Initialization routine, produces EO's, needs to be an eoInit */ void append( unsigned _newPopSize, eoInit& _chromInit ) diff --git a/eo/src/eoPrintable.h b/eo/src/eoPrintable.h index 4326f09a..9d419047 100644 --- a/eo/src/eoPrintable.h +++ b/eo/src/eoPrintable.h @@ -38,7 +38,7 @@ some objects (for instance, a #eoFactory# or a random number generator. /** Base class for objects that can print themselves (#printOn#). Besides, this file defines the standard output for all the objects; -if the objects define printOn there's no need to define #operator <<#. +if the objects define printOn there's no need to define "operator<<". @ingroup Core */ diff --git a/eo/src/eoReduceMerge.h b/eo/src/eoReduceMerge.h index 03e025ac..2e653018 100644 --- a/eo/src/eoReduceMerge.h +++ b/eo/src/eoReduceMerge.h @@ -48,10 +48,11 @@ eoReduceMerge: Replacement strategies that start by reducing the parents, This is the way to do SSGA: the offspring gets inserted in the population even if it is worse than anybody else. -@classes: eoReduceMerge, eoSSGAWorseReplacement, - eoSSGADetTournamentReplacement, eoSSGAStochTournamentReplacement +@see eoReduceMerge +@see eoSSGAWorseReplacement +@see eoSSGADetTournamentReplacement +@see eoSSGAStochTournamentReplacement */ - template class eoReduceMerge : public eoReplacement { diff --git a/eo/src/eoRingTopology.h b/eo/src/eoRingTopology.h index 8d74a83a..74705ac1 100644 --- a/eo/src/eoRingTopology.h +++ b/eo/src/eoRingTopology.h @@ -142,8 +142,6 @@ public: /** * Print the structure of the topology on the standard output. - * @param - * @return */ void printOn() { diff --git a/eo/src/eoSGATransform.h b/eo/src/eoSGATransform.h index 3707862f..57d5ea81 100644 --- a/eo/src/eoSGATransform.h +++ b/eo/src/eoSGATransform.h @@ -59,7 +59,7 @@ template class eoSGATransform : public eoTransform /** * Transforms a population. - * @param pop The population to be transformed. + * @param _pop The population to be transformed. */ void operator()(eoPop& _pop) { @@ -124,7 +124,7 @@ template class eoDynSGATransform : public eoTransform /** * Transforms a population. - * @param pop The population to be transformed. + * @param _pop The population to be transformed. */ void operator()(eoPop& _pop) { diff --git a/eo/src/eoSecondsElapsedContinue.h b/eo/src/eoSecondsElapsedContinue.h index 4a9d677f..ec1486d1 100644 --- a/eo/src/eoSecondsElapsedContinue.h +++ b/eo/src/eoSecondsElapsedContinue.h @@ -53,11 +53,17 @@ public: virtual std::string className(void) const { return "eoSecondsElapsedContinue"; } + /** REad from a stream + * @param __is the ostream to read from + */ void readFrom (std :: istream & __is) { __is >> start >> seconds; } + /** Print on a stream + * @param __os the ostream to print on + */ void printOn (std :: ostream & __os) const { __os << start << ' ' << seconds << std :: endl; diff --git a/eo/src/eoSharingSelect.h b/eo/src/eoSharingSelect.h index 75daa0ae..d9b56568 100644 --- a/eo/src/eoSharingSelect.h +++ b/eo/src/eoSharingSelect.h @@ -45,7 +45,8 @@ class eoSharingSelect: public eoRouletteWorthSelect { public: /** Ctor: - * @param _s the sigma_share + * @param _sigma the sigma_share + * @param _dist the distance object to use */ eoSharingSelect(double _sigma, eoDistance & _dist): eoRouletteWorthSelect(sharing), sharing(_sigma, _dist) {} diff --git a/eo/src/eoShiftMutation.h b/eo/src/eoShiftMutation.h index cacb9b3d..d1a13268 100644 --- a/eo/src/eoShiftMutation.h +++ b/eo/src/eoShiftMutation.h @@ -53,7 +53,7 @@ template class eoShiftMutation: public eoMonOp /** * Shift two components of the given eoosome. - * @param eo The cromosome which is going to be changed. + * @param _eo The cromosome which is going to be changed. */ bool operator()(EOT& _eo) { diff --git a/eo/src/eoSimpleEDA.h b/eo/src/eoSimpleEDA.h index ce9d80ad..c2a75672 100644 --- a/eo/src/eoSimpleEDA.h +++ b/eo/src/eoSimpleEDA.h @@ -49,8 +49,8 @@ template class eoSimpleEDA: public eoEDA { public: - /** Ctor from an eoDistribUpdater - * ... plus an eoEval and eoContinue of course + /** Ctor from an eoDistribUpdater, + * plus an eoEval and eoContinue of course. */ eoSimpleEDA(eoDistribUpdater& _update, eoEvalFunc& _eval, diff --git a/eo/src/eoStandardVelocity.h b/eo/src/eoStandardVelocity.h index a66f13d8..e2b6deb1 100644 --- a/eo/src/eoStandardVelocity.h +++ b/eo/src/eoStandardVelocity.h @@ -60,7 +60,7 @@ public: * @param _c2 - 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 */ eoStandardVelocity (eoTopology < POT > & _topology, diff --git a/eo/src/eoStarTopology.h b/eo/src/eoStarTopology.h index ed6ec8ec..d491800c 100644 --- a/eo/src/eoStarTopology.h +++ b/eo/src/eoStarTopology.h @@ -122,8 +122,6 @@ public: /** * Print the structure of the topology on the standard output. - * @param - * @return */ void printOn() { diff --git a/eo/src/eoTruncatedSelectOne.h b/eo/src/eoTruncatedSelectOne.h index b515cf49..c0fed203 100644 --- a/eo/src/eoTruncatedSelectOne.h +++ b/eo/src/eoTruncatedSelectOne.h @@ -93,8 +93,8 @@ public: /** The implementation selects an individual from the fertile pop - @param _source the source population - @param _dest the selected guy + @param _pop the source population + @return the selected guy */ const EOT& operator()(const eoPop& _pop) { diff --git a/eo/src/eoTwoOptMutation.h b/eo/src/eoTwoOptMutation.h index 49b199a0..054f223e 100644 --- a/eo/src/eoTwoOptMutation.h +++ b/eo/src/eoTwoOptMutation.h @@ -49,7 +49,7 @@ public: /** * - * @param eo The cromosome which is going to be changed. + * @param _eo The cromosome which is going to be changed. */ bool operator()(EOT& _eo) { // generate two different indices diff --git a/eo/src/es/eoEsChromInit.h b/eo/src/es/eoEsChromInit.h index 28976a0a..c5382890 100644 --- a/eo/src/es/eoEsChromInit.h +++ b/eo/src/es/eoEsChromInit.h @@ -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& _vecSigma) : eoRealInitBounded(_bounds), uniqueSigma(_vecSigma[0]), vecSigma(_vecSigma) diff --git a/eo/src/es/eoEsGlobalXover.h b/eo/src/es/eoEsGlobalXover.h index 8261dd61..bac4ae27 100644 --- a/eo/src/es/eoEsGlobalXover.h +++ b/eo/src/es/eoEsGlobalXover.h @@ -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& _plop) { diff --git a/eo/src/es/eoEsMutationInit.h b/eo/src/es/eoEsMutationInit.h index 0d4db55e..6ee74c2a 100644 --- a/eo/src/es/eoEsMutationInit.h +++ b/eo/src/es/eoEsMutationInit.h @@ -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) diff --git a/eo/src/es/eoNormalMutation.h b/eo/src/es/eoNormalMutation.h index b547bece..17447244 100644 --- a/eo/src/es/eoNormalMutation.h +++ b/eo/src/es/eoNormalMutation.h @@ -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 & _eval, double & _sigmaInit, unsigned _windowSize = 10, double _updateFactor=0.83, diff --git a/eo/src/es/eoReal.h b/eo/src/es/eoReal.h index 8c079c5f..925d4a3a 100644 --- a/eo/src/es/eoReal.h +++ b/eo/src/es/eoReal.h @@ -43,6 +43,7 @@ template class eoReal: public eoVector /** * (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(size, value) {} diff --git a/eo/src/es/eoRealOp.h b/eo/src/es/eoRealOp.h index 89163383..ab4d47e0 100644 --- a/eo/src/es/eoRealOp.h +++ b/eo/src/es/eoRealOp.h @@ -153,7 +153,7 @@ template class eoDetUniformMutation: public eoMonOp * 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 eoDetUniformMutation: public eoMonOp * 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 eoDetUniformMutation: public eoMonOp * 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& _epsilon, @@ -257,7 +257,7 @@ template class eoSegmentCrossover: public eoQuadOp * (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 eoSegmentCrossover: public eoQuadOp /** * 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 eoHypercubeCrossover: public eoQuadOp * (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 eoHypercubeCrossover: public eoQuadOp /** * 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 eoRealUXover: public eoQuadOp * 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) { diff --git a/eo/src/es/eoSBXcross.h b/eo/src/es/eoSBXcross.h index 5498edaf..e80e6c78 100644 --- a/eo/src/es/eoSBXcross.h +++ b/eo/src/es/eoSBXcross.h @@ -54,7 +54,7 @@ template class eoSBXCrossover: public eoQuadOp /** * 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 diff --git a/eo/src/gp/eoParseTreeDepthInit.h b/eo/src/gp/eoParseTreeDepthInit.h index 2f41c2fb..687c83f2 100644 --- a/eo/src/gp/eoParseTreeDepthInit.h +++ b/eo/src/gp/eoParseTreeDepthInit.h @@ -61,7 +61,7 @@ class eoParseTreeDepthInit : public eoInit< eoParseTree > /** * Constructor - * @parm _max_depth The maximum depth of a tree + * @param _max_depth The maximum depth of a tree * @param _initializor A std::vector containing the possible nodes * @param _grow False results in a full tree, True result is a randomly grown tree * @param _ramped_half_and_half True results in Ramped Half and Half Initialization diff --git a/eo/src/gp/eoParseTreeOp.h b/eo/src/gp/eoParseTreeOp.h index 1cc91a73..58824eea 100644 --- a/eo/src/gp/eoParseTreeOp.h +++ b/eo/src/gp/eoParseTreeOp.h @@ -338,9 +338,9 @@ class eoHoistMutation: public eoMonOp< eoParseTree > public: typedef eoParseTree EoType; + /** * Constructor - * @param none */ eoHoistMutation() : eoMonOp() diff --git a/eo/src/gp/eoStParseTreeDepthInit.h b/eo/src/gp/eoStParseTreeDepthInit.h index feb17be9..43c4c2a2 100644 --- a/eo/src/gp/eoStParseTreeDepthInit.h +++ b/eo/src/gp/eoStParseTreeDepthInit.h @@ -69,8 +69,9 @@ class eoStParseTreeDepthInit : public eoInit< eoParseTree > /** * Constructor - * @parm _max_depth The maximum depth of a tree - * @param _initializor A std::vector containing the possible nodes + * @param _max_depth The maximum depth of a tree + * @param _node A std::vector containing the possible nodes + * @param _return_type (JD_2010-11-09: don't know the use of this parameter, maybe to force implicit template instanciation?) * @param _grow False results in a full tree, True result is a randomly grown tree */ eoStParseTreeDepthInit( diff --git a/eo/src/gp/eoStParseTreeOp.h b/eo/src/gp/eoStParseTreeOp.h index 860e1a7c..eb0d1023 100644 --- a/eo/src/gp/eoStParseTreeOp.h +++ b/eo/src/gp/eoStParseTreeOp.h @@ -203,7 +203,7 @@ public: /** * Constructor - * @param _initializor The std::vector of Nodes given to the eoGpDepthInitializer + * @param _node The std::vector of Nodes given to the eoGpDepthInitializer */ eoStPointMutation( std::vector& _node) : eoMonOp() diff --git a/eo/src/utils/eoFileMonitor.h b/eo/src/utils/eoFileMonitor.h index 9a4a0f1e..b89fd1e6 100644 --- a/eo/src/utils/eoFileMonitor.h +++ b/eo/src/utils/eoFileMonitor.h @@ -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, diff --git a/eo/src/utils/eoGnuplot.h b/eo/src/utils/eoGnuplot.h index 37e6419b..783d44cc 100644 --- a/eo/src/utils/eoGnuplot.h +++ b/eo/src/utils/eoGnuplot.h @@ -44,7 +44,7 @@ public: /** Open pipe to Gnuplot. @param _title Title for gnuplot window. - @param _extra Extra parameters to gnuplot (default ). + @param _extra Extra parameters to gnuplot (default to none: ""). */ eoGnuplot(std::string _title, std::string _extra = std::string("")); diff --git a/eo/src/utils/eoHowMany.h b/eo/src/utils/eoHowMany.h index 947a0013..2f02216e 100644 --- a/eo/src/utils/eoHowMany.h +++ b/eo/src/utils/eoHowMany.h @@ -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): diff --git a/eo/src/utils/eoParser.h b/eo/src/utils/eoParser.h index 1c341504..bb8e5811 100644 --- a/eo/src/utils/eoParser.h +++ b/eo/src/utils/eoParser.h @@ -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. diff --git a/eo/src/utils/eoRealVectorBounds.h b/eo/src/utils/eoRealVectorBounds.h index c5e26b07..5e3a460f 100644 --- a/eo/src/utils/eoRealVectorBounds.h +++ b/eo/src/utils/eoRealVectorBounds.h @@ -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) ; diff --git a/eo/src/utils/eoTimeCounter.h b/eo/src/utils/eoTimeCounter.h index 27a103da..5774844b 100644 --- a/eo/src/utils/eoTimeCounter.h +++ b/eo/src/utils/eoTimeCounter.h @@ -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 {