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

Fix doc

Browse source
This commit is contained in:
quemy 2013-01-19 19:45:10 +01:00
commit 3345e4dc1d
6 changed files with 22 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

2
smp/doc/CMakeLists.txt
View file

@ -11,7 +11,7 @@ if(DOXYGEN_FOUND)
# 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} 2> /dev/null > /dev/null COMMAND ${DOXYGEN_EXECUTABLE} ${SMP_DOC_CONFIG_FILE}
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

2
smp/doc/index.h
View file

@ -4,7 +4,7 @@
ParadisEO-SMP for Symmetric MultiProcessing or Shared Memory Parallelism is a module for multicores computations on several algorithms proposed by ParadiseEO. By simply wrapping the algorithms, it allows you to refer only to the API of your algorithm instead of learning a new one. ParadisEO-SMP for Symmetric MultiProcessing or Shared Memory Parallelism is a module for multicores computations on several algorithms proposed by ParadiseEO. By simply wrapping the algorithms, it allows you to refer only to the API of your algorithm instead of learning a new one.
Different parallelism models are avaiable such as the Master / Slaves model or the Island Model. Different parallelism models are available such as the Master / Slaves Model or the Island Model.
@section tutorials Tutorials @section tutorials Tutorials

2
smp/doc/smp.doxyfile.cmake
View file

@ -1296,7 +1296,7 @@ SKIP_FUNCTION_MACROS = YES
# If a tag file is not located in the directory in which doxygen # If a tag file is not located in the directory in which doxygen
# is run, you must also specify the path to the tagfile here. # is run, you must also specify the path to the tagfile here.
TAGFILES = @SMP_BIN_DIR@/doc/eo.doxytag=http://eodev.sourceforge.net/smp/doc/html TAGFILES = @SMP_BIN_DIR@/doc/smp.doxytag=http://paradiseo.gforge.inria.fr/addon/smp/doc/index.html
# When a file name is specified after GENERATE_TAGFILE, doxygen will create # When a file name is specified after GENERATE_TAGFILE, doxygen will create
# a tag file that is based on the input files it reads. # a tag file that is based on the input files it reads.

10
smp/src/PPExpander.h
View file

@ -30,12 +30,16 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#ifndef SMP_PPE_H_ #ifndef SMP_PPE_H_
#define SMP_PPE_H_ #define SMP_PPE_H_
namespace paradiseo
{
namespace smp
{
/** Parameter Pack Expansion: Utility file to expand parameter pack /** Parameter Pack Expansion: Utility file to expand parameter pack
Utility file to expand parameter pack with the recursive method Utility file to expand parameter pack with the recursive method
**/ **/
template<class... Arg> class Loop; template<class... Arg> class Loop;
template<class T, class... Arg> template<class T, class... Arg>
@ -63,4 +67,8 @@ public:
}; };
}
}
#endif #endif

11
smp/src/islandNotifier.h
View file

@ -32,6 +32,11 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <utility> #include <utility>
namespace paradiseo
{
namespace smp
{
/** IslandNotifier: The notifier will perform the binded task each generation. /** IslandNotifier: The notifier will perform the binded task each generation.
The island notifier makes the binded task executed by the island which observes. The island notifier makes the binded task executed by the island which observes.
@ -39,12 +44,6 @@ We can imagine that a continuator checks if we have to execute the binded task.
At the moment, the task is performed each generation. At the moment, the task is performed each generation.
*/ */
namespace paradiseo
{
namespace smp
{
template <class EOT> template <class EOT>
class IslandNotifier : public eoUpdater class IslandNotifier : public eoUpdater
{ {

9
smp/src/notifier.h
View file

@ -33,15 +33,16 @@ Contact: paradiseo-help@lists.gforge.inria.fr
#include <utils/eoUpdater.h> #include <utils/eoUpdater.h>
#include <functional> #include <functional>
/** Notifier: The notifier will perform the binded task each generation.
*/
namespace paradiseo namespace paradiseo
{ {
namespace smp namespace smp
{ {
/**
Notifier: The notifier will perform the binded task each generation.
*/
class Notifier : public eoUpdater class Notifier : public eoUpdater
{ {
public : public :