Doc revised

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

trunk/paradiseo-mo/src/neighborhood/moBackableNeighbor.h

@@ -46,7 +46,7 @@ class moBackableNeighbor : virtual public moNeighbor<EOT, Fitness>
 public:
 
     /**
-     * the move back function
+     * the function to move back a solution
      * @param _solution the solution to moveBack
      */
     virtual void moveBack(EOT & _solution)=0;

trunk/paradiseo-mo/src/neighborhood/moDummyNeighborhood.h

@@ -43,7 +43,7 @@ public:
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      * @return always false
      */
     virtual bool hasNeighbor(EOT & _solution) {
@@ -52,21 +52,21 @@ public:
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
-     * @param _current a neighbor (unused)
+     * @param _solution unused solution
+     * @param _current unused neighbor
      */
     virtual void init(EOT & _solution, Neighbor & _current) {}
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
-     * @param _current a neighbor (unused)
+     * @param _solution unused solution
+     * @param _current unused neighbor
      */
     virtual void next(EOT & _solution, Neighbor & _current) {}
 
     /**
      * NOTHING TO DO
-     * @param _solution a solution (unused)
+     * @param _solution unused solution
      * @return always false
      */
     virtual bool cont(EOT & _solution) {

trunk/paradiseo-mo/src/neighborhood/moIndexNeighbor.h

@@ -71,7 +71,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/neighborhood/moNeighbor.h

@@ -79,7 +79,7 @@ public:
     virtual void move(EOT & _solution) = 0 ;
 
     /**
-     * Get the fitness of the neighbor
+     * Get the fitness
      * @return fitness of the neighbor
      */
     const Fitness fitness() const {
@@ -104,6 +104,7 @@ public:
     }
 
     /**
+     * Test equality between two neighbors
      * @param _neighbor a neighbor
      * @return if _neighbor and this one are equals
      */
@@ -112,7 +113,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/neighborhood/moNeighborhood.h

@@ -55,7 +55,7 @@ public:
     moNeighborhood() {}
 
     /**
-     * @return if the neighborhood is random (default false)
+     * @return true if the neighborhood is random (default false)
      */
     virtual bool isRandom() {
         return false;
@@ -64,7 +64,7 @@ public:
     /**
      * Test if a solution has (again) a Neighbor
      * @param _solution the related solution
-     * @return if _solution has a Neighbor
+     * @return true if _solution has a Neighbor
      */
     virtual bool hasNeighbor(EOT & _solution) = 0 ;
 
@@ -85,12 +85,12 @@ 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) = 0 ;
 
     /**
-     * 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/neighborhood/moOrderNeighborhood.h

@@ -38,7 +38,7 @@
 #include <neighborhood/moIndexNeighborhood.h>
 
 /**
- * A Ordered Neighborhood
+ * An ordered Neighborhood
  */
 template< class Neighbor >
 class moOrderNeighborhood : public moIndexNeighborhood<Neighbor>
@@ -59,7 +59,7 @@ public:
     moOrderNeighborhood(unsigned int _neighborhoodSize): moIndexNeighborhood<Neighbor>(_neighborhoodSize), currentIndex(0) {}
 
     /**
-     * Test if it exist a neighbor
+     * Test if a neighbor exists
      * @param _solution the solution to explore
      * @return true if the neighborhood was not empty
      */
@@ -107,7 +107,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/neighborhood/moRndWithReplNeighborhood.h

@@ -97,7 +97,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/neighborhood/moRndWithoutReplNeighborhood.h

@@ -123,7 +123,7 @@ public:
     }
 
     /**
-     * Return the class id.
+     * Return the class Name
      * @return the class name as a std::string
      */
     virtual std::string className() const {