Doc revised

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

trunk/paradiseo-mo/src/problems/bitString/moBitNeighbor.h

@@ -68,7 +68,7 @@ public:
     }
 
     /**
-     * Return the class id.
+     * return the class name
      * @return the class name as a std::string
      */
     virtual std::string className() const {
@@ -76,7 +76,7 @@ public:
     }
 
     /**
-     * Read object.\							\
+     * Read object.\
      * Calls base class, just in case that one had something to do.
      * The read and print methods should be compatible and have the same format.
      * In principle, format is "plain": they just print a number
@@ -92,7 +92,7 @@ public:
         }
         else {
             Fitness repFit ;
-            _is.seekg(pos); // rewind
+            _is.seekg(pos);
             _is >> repFit;
             _is >> key;
             fitness(repFit);

trunk/paradiseo-mo/src/problems/eval/moMaxSATincrEval.h

@@ -49,7 +49,7 @@ public :
         variables = _fulleval.variables;
     }
 
-    /*
+    /**
      * incremental evaluation of the neighbor for the max SAT problem
      * @param _solution the solution (of type bit string) to move
      * @param _neighbor the neighbor (of type moBitNeigbor) to consider

trunk/paradiseo-mo/src/problems/eval/moRoyalRoadIncrEval.h

@@ -43,12 +43,12 @@ public:
     typedef typename Neighbor::EOT EOT;
 
     /**
-     * Default constructor
+     * Constructor
      * @param _rr full evaluation of the Royal Road (to have the same block size)
      */
     moRoyalRoadIncrEval(RoyalRoadEval<EOT> & _rr) : k(_rr.blockSize()) {}
 
-    /*
+    /**
      * incremental evaluation of the neighbor for the Royal Road problem
      * @param _solution the solution to move (bit string)
      * @param _neighbor the neighbor to consider (of type moBitNeigbor)

trunk/paradiseo-mo/src/problems/permutation/moSwapNeighbor.h

@@ -55,7 +55,7 @@ public:
 
     /**
      * apply the swap to restore the solution (use by moFullEvalByModif)
-     * @param _solution the solution to move
+     * @param _solution the solution to move back
      */
     virtual void moveBack(EOT& _solution) {
         unsigned int tmp;

trunk/paradiseo-mo/src/problems/permutation/moSwapNeighborhood.h

@@ -43,7 +43,7 @@ public:
     typedef moSwapNeighbor<EOT, Fitness> Neighbor;
 
     /**
-     * @return if there are available Neighbor
+     * @return true if there is at least an available neighbor
      */
     virtual bool hasNeighbor(EOT& _solution) {
         return (_solution.size() > 1);
@@ -79,14 +79,14 @@ public:
     /**
      * Test if there is again a neighbor
      * @param _solution the solution to explore
-     * @return if there is again a neighbor not explored
+     * @return true if there is again a neighbor not explored
      */
     virtual bool cont(EOT& _solution) {
         return !((indices.first == (size-2)) && (indices.second == (size-1)));
     }
 
     /**
-     * Return the class id.
+     * Return the class Name
      * @return the class name as a std::string
      */
     virtual std::string className() const {