Début du nettoyage et verif de la doc

git-svn-id: svn://scm.gforge.inria.fr/svnroot/paradiseo@1811 331e1502-861f-0410-8da2-ba01fb791d7f

trunk/paradiseo-mo/src/continuator/moAverageFitnessNeighborStat.h

@@ -39,7 +39,7 @@
 #include <continuator/moNeighborhoodStat.h>
 
 /**
- * From moNeighborhoodStat, to compute the average and the standard deviation of fitness in the neighborhood
+ * From moNeighborhoodStat, to compute the average of fitness in the neighborhood
  */
 template< class Neighbor >
 class moAverageFitnessNeighborStat : public moStat<typename Neighbor::EOT, double >

trunk/paradiseo-mo/src/continuator/moCombinedContinuator.h

@@ -33,6 +33,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 #include <continuator/moContinuator.h>
 #include <neighborhood/moNeighborhood.h>
 #include <vector>
+
 /**
  * Combined several continuators
  * Continue until one of the continuators is false

trunk/paradiseo-mo/src/continuator/moCounterMonitorSaver.h

@@ -39,9 +39,7 @@
 #include <utils/eoMonitor.h>
 
 /**
- * The actual class that will be used as base for all statistics
- * that need to be calculated over the solution
- * It is a moStatBase AND an eoValueParam so it can be used in Monitors.
+ * Class calling monitors with a given frequency
  */
 class moCounterMonitorSaver : public eoUpdater {
 public :

trunk/paradiseo-mo/src/continuator/moFitContinuator.h

@@ -32,6 +32,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 
 #include <continuator/moContinuator.h>
 #include <neighborhood/moNeighborhood.h>
+
 /**
  * Continue until a maximum fitness is reached
  */

trunk/paradiseo-mo/src/continuator/moFitnessStat.h

@@ -38,10 +38,8 @@
 #include <continuator/moStat.h>
 
 /**
- * The actual class that will be used as base for all statistics
- * that need to be calculated over the solution
- * It is a moStatBase AND an eoValueParam so it can be used in Monitors.
-*/
+ * Stat given the fitness of the current solution
+ */
 template <class EOT>
 class moFitnessStat : public moStat<EOT, typename EOT::Fitness>
 {

trunk/paradiseo-mo/src/continuator/moFullEvalContinuator.h

@@ -57,8 +57,8 @@ public:
   
   /**
    * Test if continue
-   *@param _solution a solution
-   *@return true if number of evaluations < maxFullEval
+   * @param _solution a solution
+   * @return true if number of evaluations < maxFullEval
    */
   virtual bool operator()(EOT & _solution) {
     return (eval.value() - nbEval_start < maxFullEval);

trunk/paradiseo-mo/src/continuator/moIterContinuator.h

@@ -32,6 +32,7 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 
 #include <continuator/moContinuator.h>
 #include <neighborhood/moNeighborhood.h>
+
 /**
  * Continue until a maximum fixed number of iterations is reached
  */
@@ -43,6 +44,7 @@ public:
 
 	/**
 	 * @param _maxIter number maximum of iterations
+	 * @param _verbose true/false : verbose mode on/off
 	 */
     moIterContinuator(unsigned int _maxIter, bool _verbose=true): maxIter(_maxIter), verbose(_verbose){}
 

trunk/paradiseo-mo/src/continuator/moMaxNeighborStat.h

@@ -38,6 +38,7 @@
 #include <continuator/moStat.h>
 #include <continuator/moNeighborhoodStat.h>
 #include <neighborhood/moNeighborhood.h>
+
 /**
  * From moNeighborhoodStat, to compute the max fitness in the neighborhood
  */

trunk/paradiseo-mo/src/continuator/moMinNeighborStat.h

@@ -38,6 +38,7 @@
 #include <continuator/moStat.h>
 #include <continuator/moNeighborhoodStat.h>
 #include <neighborhood/moNeighborhood.h>
+
 /**
  * From moNeighborhoodStat, to compute the min fitness in the neighborhood
  */

trunk/paradiseo-mo/src/continuator/moNbInfNeighborStat.h

@@ -38,11 +38,10 @@
 #include <continuator/moStat.h>
 #include <continuator/moNeighborhoodStat.h>
 #include <neighborhood/moNeighborhood.h>
+
 /**
- *
  * From moNeighborhoodStat, to compute the number of solutions in the neighborhood
  * with (strictly) lower fitness than the current solution
- *
 */
 template< class Neighbor >
 class moNbInfNeighborStat : public moStat<typename Neighbor::EOT, unsigned>

trunk/paradiseo-mo/src/continuator/moNbSupNeighborStat.h

@@ -38,12 +38,11 @@
 #include <continuator/moStat.h>
 #include <continuator/moNeighborhoodStat.h>
 #include <neighborhood/moNeighborhood.h>
+
 /**
- *
  * From moNeighborhoodStat, to compute the number of solutions in the neighborhood
  * with higher fitness than the current solution
- *
-*/
+ */
 template< class Neighbor >
 class moNbSupNeighborStat : public moStat<typename Neighbor::EOT, unsigned>
 {

trunk/paradiseo-mo/src/continuator/moNeighborBestStat.h

@@ -77,6 +77,7 @@ public :
      *
      * @param _neighborhood a neighborhood
      * @param _eval an evaluation function
+     * @param _k number of neighbors visited (default all)
      */
   moNeighborBestStat(Neighborhood& _neighborhood, moEval<Neighbor>& _eval, unsigned _k = 0):
       moStat<EOT, Fitness>(Fitness(), "best"),