From 8ee0745b075ff7013f67a3514179cbe56da0255b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ad=C3=A8le=20Harrissart?= <adele.harrissart@gmail.com>
Date: Fri, 13 Jun 2014 15:46:13 +0200
Subject: [PATCH] Error and problems with smp documentation compilation ("make
 doc" or "make doc-smp" command with -DSMP=true flag).

Here the error :

error: Tag file `/home/aharrissart/workspace/thales/paradiseo/build/doc/smp.doxytag' does not exist or is not a file. Skipping it...

Some other problems with undocumented parameters...

Now resolved.
---
 smp/doc/CMakeLists.txt              | 9 ++++++---
 smp/src/MWModel.h                   | 4 ++--
 smp/src/bimap.h                     | 8 ++++----
 smp/src/island.h                    | 4 ++--
 smp/src/topology/abstractTopology.h | 2 +-
 5 files changed, 15 insertions(+), 12 deletions(-)

diff --git a/smp/doc/CMakeLists.txt b/smp/doc/CMakeLists.txt
index 3fa4481eb..c735832cb 100644
--- a/smp/doc/CMakeLists.txt
+++ b/smp/doc/CMakeLists.txt
@@ -7,12 +7,15 @@ if(DOXYGEN_FOUND)
     set(SMP_DOC_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE INTERNAL "Documentation directory" FORCE)
     # Name of the doxygene configuration file
     set(SMP_DOC_CONFIG_FILE "smp.doxyfile" CACHE INTERNAL "Documentation configuration file")
+
+    CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/index.h ${EO_DOC_DIR}/index.h COPYONLY)
+    
     if(DOXYGEN_EXECUTABLE)
         # Creating the custom target
         if(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
             add_custom_target(doc-smp
-                COMMAND ${DOXYGEN_EXECUTABLE} ${SMP_DOC_CONFIG_FILE} 
-                WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
+                COMMAND ${DOXYGEN_EXECUTABLE} ${SMP_DOC_CONFIG_FILE} 2> /dev/null > /dev/null
+                WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) 
         else(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
             add_custom_target(doc-smp
                 COMMAND ${DOXYGEN_EXECUTABLE} ${SMP_DOC_CONFIG_FILE}
@@ -20,7 +23,7 @@ if(DOXYGEN_FOUND)
         endif(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
     endif(DOXYGEN_EXECUTABLE)
     configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${SMP_DOC_CONFIG_FILE}.cmake"
-                   "${SMP_DOC_DIR}/${SMP_DOC_CONFIG_FILE}")
+                   "${CMAKE_CURRENT_BINARY_DIR}/${SMP_DOC_CONFIG_FILE}")
     install(
         DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
         DESTINATION share${INSTALL_SUB_DIR}/smp COMPONENT doc
diff --git a/smp/src/MWModel.h b/smp/src/MWModel.h
index cad614851..c3183f06b 100644
--- a/smp/src/MWModel.h
+++ b/smp/src/MWModel.h
@@ -59,14 +59,14 @@ public:
     /**
      * Constructor
      * @param workersNb the number of workers
-     * @param args... list of parameters according to the constructor of your algorithm
+     * @param args list of parameters according to the constructor of your algorithm
      */
     template<class... Args>
     MWModel(unsigned workersNb, Args&... args);
 
     /**
      * Constructor
-     * @param args... list of parameters according to the constructor of your algorithm
+     * @param args list of parameters according to the constructor of your algorithm
      */
     template<class... Args>
     MWModel(Args&... args);
diff --git a/smp/src/bimap.h b/smp/src/bimap.h
index caf17f25e..024f4d12c 100644
--- a/smp/src/bimap.h
+++ b/smp/src/bimap.h
@@ -50,8 +50,8 @@ class Bimap
 public:
     /**
      * Add a relation 
-     * @param A right key
-     * @param B left key
+     * @param a Right key
+     * @param b Left key
      */
     void add(A& a, B& b);
     
@@ -69,13 +69,13 @@ public:
     
     /**
      * Remove an association from a right key.
-     * @param Right key of the association to be removed.
+     * @param a Right key of the association to be removed.
      */
     void removeFromRight(const A& a);
     
     /**
      * Remove an association from a left key.
-     * @param Left key of the association to be removed.
+     * @param b Left key of the association to be removed.
      */
     void removeFromLeft(const B& b);
 
diff --git a/smp/src/island.h b/smp/src/island.h
index 752b671ef..546a69efa 100644
--- a/smp/src/island.h
+++ b/smp/src/island.h
@@ -77,7 +77,7 @@ public:
      * @param args Parameters to construct the algorithm.
      */
     template<class... Args>
-    Island(std::function<EOT(bEOT&)> _convertFromBase, std::function<bEOT(EOT&)> _convertToBase, eoPop<EOT>& pop, IntPolicy<EOT>& _intPolicy, MigPolicy<EOT>& _migPolicy, Args&... args);
+    Island(std::function<EOT(bEOT&)> _convertFromBase, std::function<bEOT(EOT&)> _convertToBase, eoPop<EOT>& _pop, IntPolicy<EOT>& _intPolicy, MigPolicy<EOT>& _migPolicy, Args&... args);
     /**
      * Constructor
      * @param _pop Population of the island
@@ -86,7 +86,7 @@ public:
      * @param args Parameters to construct the algorithm.
      */
     template<class... Args>
-    Island(eoPop<EOT>& pop, IntPolicy<EOT>& _intPolicy, MigPolicy<EOT>& _migPolicy, Args&... args);
+    Island(eoPop<EOT>& _pop, IntPolicy<EOT>& _intPolicy, MigPolicy<EOT>& _migPolicy, Args&... args);
     
     /**
      * Start the island.
diff --git a/smp/src/topology/abstractTopology.h b/smp/src/topology/abstractTopology.h
index fcd311441..061e3aea1 100644
--- a/smp/src/topology/abstractTopology.h
+++ b/smp/src/topology/abstractTopology.h
@@ -52,7 +52,7 @@ public :
     * Return a vector containing the index of nearby nodes according to the topology
     * @param idNode index of the node of which you want the neighbors.
     */
-	virtual std::vector<unsigned> getIdNeighbors(unsigned idIsland) const = 0;
+	virtual std::vector<unsigned> getIdNeighbors(unsigned idNode) const = 0;
 	
 	/**
 	* Construct or re-construct a topology with the given number of nodes.