nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Error and problems with smp documentation compilation ("make doc" or "make doc-smp" command with -DSMP=true flag).

Browse source 
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.
This commit is contained in:
Adèle Harrissart 2014-06-13 15:46:13 +02:00
commit 8ee0745b07
5 changed files with 15 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

7
smp/doc/CMakeLists.txt
View file

@ -7,11 +7,14 @@ if(DOXYGEN_FOUND)
set(SMP_DOC_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE INTERNAL "Documentation directory" FORCE) set(SMP_DOC_DIR ${CMAKE_CURRENT_BINARY_DIR} CACHE INTERNAL "Documentation directory" FORCE)
# Name of the doxygene configuration file # Name of the doxygene configuration file
set(SMP_DOC_CONFIG_FILE "smp.doxyfile" CACHE INTERNAL "Documentation 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) if(DOXYGEN_EXECUTABLE)
# Creating the custom target # Creating the custom target
if(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE}) if(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
add_custom_target(doc-smp add_custom_target(doc-smp
COMMAND ${DOXYGEN_EXECUTABLE} ${SMP_DOC_CONFIG_FILE} COMMAND ${DOXYGEN_EXECUTABLE} ${SMP_DOC_CONFIG_FILE} 2> /dev/null > /dev/null
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}) WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
else(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE}) else(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
add_custom_target(doc-smp add_custom_target(doc-smp
@ -20,7 +23,7 @@ if(DOXYGEN_FOUND)
endif(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE}) endif(UNIX AND NOT ${CMAKE_VERBOSE_MAKEFILE})
endif(DOXYGEN_EXECUTABLE) endif(DOXYGEN_EXECUTABLE)
configure_file("${CMAKE_CURRENT_SOURCE_DIR}/${SMP_DOC_CONFIG_FILE}.cmake" 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( install(
DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
DESTINATION share${INSTALL_SUB_DIR}/smp COMPONENT doc DESTINATION share${INSTALL_SUB_DIR}/smp COMPONENT doc

4
smp/src/MWModel.h
View file

@ -59,14 +59,14 @@ public:
/** /**
* Constructor * Constructor
* @param workersNb the number of workers * @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> template<class... Args>
MWModel(unsigned workersNb, Args&... args); MWModel(unsigned workersNb, Args&... args);
/** /**
* Constructor * 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> template<class... Args>
MWModel(Args&... args); MWModel(Args&... args);

8
smp/src/bimap.h
View file

@ -50,8 +50,8 @@ class Bimap
public: public:
/** /**
* Add a relation * Add a relation
* @param A right key * @param a Right key
* @param B left key * @param b Left key
*/ */
void add(A& a, B& b); void add(A& a, B& b);
@ -69,13 +69,13 @@ public:
/** /**
* Remove an association from a right key. * 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); void removeFromRight(const A& a);
/** /**
* Remove an association from a left key. * 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); void removeFromLeft(const B& b);

4
smp/src/island.h
View file

@ -77,7 +77,7 @@ public:
* @param args Parameters to construct the algorithm. * @param args Parameters to construct the algorithm.
*/ */
template<class... Args> 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 * Constructor
* @param _pop Population of the island * @param _pop Population of the island
@ -86,7 +86,7 @@ public:
* @param args Parameters to construct the algorithm. * @param args Parameters to construct the algorithm.
*/ */
template<class... Args> 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. * Start the island.

2
smp/src/topology/abstractTopology.h
View file

@ -52,7 +52,7 @@ public :
* Return a vector containing the index of nearby nodes according to the topology * 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. * @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. * Construct or re-construct a topology with the given number of nodes.