Doc revised

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

trunk/paradiseo-mo/src/explorer/moDummyExplorer.h

@@ -52,19 +52,19 @@ public:
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     void initParam (EOT& _solution) { } ;
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     void updateParam (EOT& _solution) { } ;
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      * @return always false
      */
     bool isContinue(EOT& _solution) {
@@ -73,13 +73,13 @@ public:
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     void move(EOT& _solution) { } ;
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      * @return always false
      */
     virtual bool accept(EOT& _solution) {
@@ -88,18 +88,18 @@ public:
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void terminate(EOT& _solution) { } ;
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     void operator()(EOT & _solution) { }
 
     /**
-     * Return the class id.
+     * Return the class name
      * @return the class name as a std::string
      */
     virtual std::string className() const {

trunk/paradiseo-mo/src/explorer/moFirstImprHCexplorer.h

@@ -74,19 +74,19 @@ public:
 
     /**
      * initParam: NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void initParam(EOT & _solution) {};
 
     /**
      * updateParam: NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void updateParam(EOT & _solution) {};
 
     /**
      * terminate: NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void terminate(EOT & _solution) {};
 
@@ -121,7 +121,7 @@ public:
     /**
      * continue if a move is accepted
      * @param _solution the solution
-     * @return true if an ameliorated neighbor was be found
+     * @return true if an ameliorated neighbor was found
      */
     virtual bool isContinue(EOT & _solution) {
         return isAccept ;
@@ -139,7 +139,7 @@ public:
     };
 
     /**
-     * accept test if an ameliorated neighbor was be found
+     * accept test if an ameliorated neighbor was found
      * @param _solution the solution
      * @return true if the best neighbor ameliorate the fitness
      */

trunk/paradiseo-mo/src/explorer/moILSexplorer.h

@@ -141,7 +141,7 @@ public:
     };
 
     /**
-     * accept test if an ameliorated neighbor was be found
+     * accept test if an ameliorated neighbor was found
      * @param _solution the solution
      * @return true if acceptance criteria is verified
      */
@@ -150,7 +150,7 @@ public:
     };
 
     /**
-     * Return the class id.
+     * Return the class Name
      * @return the class name as a std::string
      */
     virtual std::string className() const {

trunk/paradiseo-mo/src/explorer/moMetropolisHastingExplorer.h

@@ -45,7 +45,7 @@
 #include <utils/eoRNG.h>
 
 /**
- * Explorer for the Metropolis-Hasting Sampling
+ * Explorer for the Metropolis-Hasting Sampling.
  * Only the symetric case is considered when Q(x,y) = Q(y,x)
  * Fitness must be > 0
  */
@@ -84,7 +84,7 @@ public:
 
     /**
      * initialization of the number of step to be done
-     * @param _solution the solution (unused here)
+     * @param _solution unused solution
      */
     virtual void initParam(EOT & _solution) {
         step     = 0;
@@ -93,7 +93,7 @@ public:
 
     /**
      * increase the number of step
-     * @param _solution the solution (unused here)
+     * @param _solution unused solution
      */
     virtual void updateParam(EOT & _solution) {
         step++;
@@ -101,7 +101,7 @@ public:
 
     /**
      * terminate: NOTHING TO DO
-     * @param _solution the solution (unused here)
+     * @param _solution unused solution
      */
     virtual void terminate(EOT & _solution) {};
 
@@ -145,7 +145,7 @@ public:
     };
 
     /**
-     * accept test if an ameliorated neighbor was be found
+     * accept test if an ameliorated neighbor was found
      * @param _solution the solution
      * @return true if the best neighbor ameliorate the fitness
      */

trunk/paradiseo-mo/src/explorer/moNeighborhoodExplorer.h

@@ -40,7 +40,6 @@
 
 #include <neighborhood/moNeighborhood.h>
 #include <eval/moEval.h>
-//#include <neighborhood/moDummyNeighbor.h>
 #include <neighborhood/moDummyNeighborhood.h>
 #include <eval/moDummyEval.h>
 
@@ -102,9 +101,8 @@ public:
      */
     virtual void terminate(EOT& _solution) = 0 ;
 
-
     /**
-     * Getter for variable "isMoved"
+     * Getter of "isMoved"
      * @return true if move is applied
      */
     bool moveApplied() {
@@ -112,7 +110,7 @@ public:
     }
 
     /**
-     * Setter for variable "isMoved"
+     * Setter of "isMoved"
      * @param _isMoved
      */
     void moveApplied(bool _isMoved) {

trunk/paradiseo-mo/src/explorer/moNeutralHCexplorer.h

@@ -101,7 +101,7 @@ public:
     };
 
     /**
-     * continue if there is a neighbor and it is remainds some steps to do
+     * continue if there is a neighbor and it is remains some steps to do
      * @param _solution the solution
      * @return true there is some steps to do
      */

trunk/paradiseo-mo/src/explorer/moRandomBestHCexplorer.h

@@ -83,7 +83,7 @@ public:
 
     /**
      * empty the vector of best solutions
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void initParam(EOT & _solution) {
         // delete all the best solutions
@@ -92,7 +92,7 @@ public:
 
     /**
      * empty the vector of best solutions
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void updateParam(EOT & _solution) {
         // delete all the best solutions
@@ -101,7 +101,7 @@ public:
 
     /**
      * terminate: NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void terminate(EOT & _solution) {};
 
@@ -170,7 +170,7 @@ public:
     };
 
     /**
-     * accept test if an amelirated neighbor was be found
+     * accept test if an amelirated neighbor was found
      * @param _solution the solution
      * @return true if the best neighbor ameliorate the fitness
      */

trunk/paradiseo-mo/src/explorer/moRandomNeutralWalkExplorer.h

@@ -85,7 +85,7 @@ public:
 
     /**
      * initialization of the number of step to be done
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void initParam(EOT & _solution) {
         step     = 0;
@@ -94,7 +94,7 @@ public:
 
     /**
      * increase the number of step
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void updateParam(EOT & _solution) {
         step++;
@@ -102,7 +102,7 @@ public:
 
     /**
      * terminate: NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void terminate(EOT & _solution) {};
 
@@ -134,7 +134,7 @@ public:
     };
 
     /**
-     * continue if there is a neighbor and it is remainds some steps to do
+     * continue if there is a neighbor and it is remains some steps to do
      * @param _solution the solution
      * @return true there is some steps to do
      */

trunk/paradiseo-mo/src/explorer/moRandomSearchExplorer.h

@@ -72,7 +72,7 @@ public:
 
     /**
      * initialization of the number of step to be done
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void initParam(EOT & _solution) {
         step     = 0;
@@ -80,7 +80,7 @@ public:
 
     /**
      * increase the number of step
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void updateParam(EOT & _solution) {
         step++;
@@ -88,7 +88,7 @@ public:
 
     /**
      * terminate: NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void terminate(EOT & _solution) {};
 
@@ -106,7 +106,7 @@ public:
     };
 
     /**
-     * continue if it is remainds some steps to do
+     * continue if it is remains some steps to do
      * @param _solution the solution
      * @return true there is some steps to do
      */

trunk/paradiseo-mo/src/explorer/moRandomWalkExplorer.h

@@ -41,7 +41,7 @@
 #include <neighborhood/moNeighborhood.h>
 
 /**
- * Explorer for a random walk explorer
+ * Explorer for a random walk
  */
 template< class Neighbor >
 class moRandomWalkExplorer : public moNeighborhoodExplorer<Neighbor>
@@ -78,7 +78,7 @@ public:
 
     /**
      * initialization of the number of step to be done
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void initParam(EOT & _solution) {
         step     = 0;
@@ -87,7 +87,7 @@ public:
 
     /**
      * increase the number of step
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void updateParam(EOT & _solution) {
         step++;
@@ -95,7 +95,7 @@ public:
 
     /**
      * terminate: NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      */
     virtual void terminate(EOT & _solution) {};
 
@@ -123,7 +123,7 @@ public:
     };
 
     /**
-     * continue if there is a neighbor and it is remainds some steps to do
+     * continue if there is a neighbor and it is remains some steps to do
      * @param _solution the solution
      * @return true there is some steps to do
      */

trunk/paradiseo-mo/src/explorer/moSAexplorer.h

@@ -92,7 +92,7 @@ public:
 
     /**
      * decrease the temperature if necessary
-     * @param _solution the solution (unused here)
+     * @param _solution unused solution
      */
     virtual void updateParam(EOT & _solution) {
         coolingSchedule.update(temperature);
@@ -100,13 +100,13 @@ public:
 
     /**
      * terminate: NOTHING TO DO
-     * @param _solution the solution (unused here)
+     * @param _solution unused solution
      */
     virtual void terminate(EOT & _solution) {};
 
     /**
      * Explore one random solution in the neighborhood
-     * @param _solution
+     * @param _solution the solution
      */
     virtual void operator()(EOT & _solution) {
         //Test if _solution has a Neighbor
@@ -133,7 +133,7 @@ public:
     };
 
     /**
-     * move the solution on the accepted solution
+     * move the solution to the accepted solution
      * @param _solution the solution to move
      */
     virtual void move(EOT & _solution) {

trunk/paradiseo-mo/src/explorer/moSimpleHCexplorer.h

@@ -76,26 +76,27 @@ public:
 
     /**
      * initParam: NOTHING TO DO
+     * @param _solution unused solution
      */
-    virtual void initParam(EOT & solution) {};
+    virtual void initParam(EOT & _solution) {};
 
     /**
      * updateParam: NOTHING TO DO
+     * @param _solution unused solution
      */
-    virtual void updateParam(EOT & solution) {};
+    virtual void updateParam(EOT & _solution) {};
 
     /**
      * terminate: NOTHING TO DO
+     * @param _solution unused solution
      */
-    virtual void terminate(EOT & solution) {};
+    virtual void terminate(EOT & _solution) {};
 
     /**
      * Explore the neighborhood of a solution
-     * @param _solution
+     * @param _solution the current solution
      */
     virtual void operator()(EOT & _solution) {
-
-        //est qu'on peut initializer
         //Test if _solution has a Neighbor
         if (neighborhood.hasNeighbor(_solution)) {
             //init the first neighbor
@@ -159,7 +160,7 @@ public:
     };
 
     /**
-     * Return the class id.
+     * Return the class Name
      * @return the class name as a std::string
      */
     virtual std::string className() const {

trunk/paradiseo-mo/src/explorer/moTSexplorer.h

@@ -214,7 +214,7 @@ public:
 
 
     /**
-     * accept test if an ameliorated neighbor was be found
+     * accept test if an ameliorated neighbor was found
      * @param _solution the solution
      * @return true if the best neighbor ameliorate the fitness
      */