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

Taking in account Doxygen remarks, fixed some documentation errors.

Browse source
This commit is contained in:
Benjamin Bouvier 2012-07-13 14:45:56 +02:00
commit f9a0084f95
4 changed files with 6 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

3
eo/src/mpi/eoMpi.h
View file

@ -514,12 +514,15 @@ namespace eo
* AssignmentAlgorithm for more details.
*
* @param _masterRank The MPI rank of the master.
*
* @param _workerStopCondition Number of the message which will cause the workers to terminate. It could
* be one of the constants defined in eo::mpi::Commands, or any other integer. The user has to be sure
* that a message containing this integer will be sent to each worker on the Commands channel, otherwise
* deadlock will happen. Master sends Finish messages at the end of a simple job, but as a job can
* happen multiples times (multi job), workers don't have to really finish on these messages but on
* another message. This is here where you can configurate it. See also OneShotJob and MultiJob.
*
* @param store The JobStore containing functors and data for this job.
*/
Job( AssignmentAlgorithm& _algo,
int _masterRank,

2
eo/src/mpi/eoMpiAssignmentAlgorithm.h
View file

@ -78,7 +78,7 @@ namespace eo
* the workers which are currently processing data, and the other ones who could be waiting : the idles.
* This function indicates to the master which worker aren't doing anything.
*
* @param A std::vector containing all the MPI ranks of the idles workers.
* @return A std::vector containing all the MPI ranks of the idles workers.
*/
virtual std::vector<int> idles( ) = 0;

2
eo/src/serial/Object.h
View file

@ -46,7 +46,7 @@ namespace eoserial
/**
* @brief Adds a pair into the JSON object.
* @param key The key associated with the eoserial object
* @param eoserial The JSON object as created with framework.
* @param json The JSON object as created with framework.
*/
void add( const std::string& key, eoserial::Entity* json )
{

2
eo/src/serial/Parser.h
View file

@ -84,7 +84,7 @@ class Parser
*
* @param str The string we're parsing.
* @param pos The index of the current position in the string.
* @param eoserial The current JSON object for which we're adding a key-value pair.
* @param json The current JSON object for which we're adding a key-value pair.
*/
static void parseLeft(const std::string & str, size_t & pos, eoserial::Object* json);