Fin du nettoyage

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

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

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

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

@@ -54,6 +54,7 @@ public:
 
     /**
      * Copy Constructor
+     * @param _n the neighbor to copy
      */
     moIndexNeighbor(const moIndexNeighbor& _n) : moNeighbor<EOT>(_n) {
         this->key = _n.key ;
@@ -61,6 +62,7 @@ public:
 
     /**
      * Assignment operator
+     * @param _source the source neighbor
      */
     virtual moIndexNeighbor<EOT> & operator=(const moIndexNeighbor<EOT> & _source) {
         moNeighbor<EOT>::operator=(_source);

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

@@ -55,15 +55,8 @@ public:
      */
     moIndexNeighborhood(unsigned int _neighborhoodSize):neighborhoodSize(_neighborhoodSize) {}
 
-    /**
-     * Return the class id.
-     * @return the class name as a std::string
-     */
-//    virtual std::string className() const {
-//        return "moIndexNeighborhood";
-//    }
-
 protected:
+    // size of the neighborhood
     unsigned int neighborhoodSize;
 };
 

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

@@ -55,7 +55,7 @@ public:
     moNeighborhood() {}
 
     /**
-     * @return if the neighborhood is random
+     * @return if the neighborhood is random (default false)
      */
     virtual bool isRandom() {
         return false;

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

@@ -32,11 +32,17 @@ Contact: paradiseo-help@lists.gforge.inria.fr
 
 #include <neighborhood/moNeighborhood.h>
 
+/**
+ * Class used to specify a neighborhood is random
+ */
 template< class Neighbor >
 class moRndNeighborhood : virtual public moNeighborhood<Neighbor> {
 
 public:
 
+	/**
+	 * @return true
+	 */
     bool isRandom() {
         return true;
     }