From f9a0084f959033ab896fe2ad19ca42a7adc7079a Mon Sep 17 00:00:00 2001
From: Benjamin Bouvier <bnjbouv@gmail.com>
Date: Fri, 13 Jul 2012 14:45:56 +0200
Subject: [PATCH] Taking in account Doxygen remarks, fixed some documentation
 errors.

---
 eo/src/mpi/eoMpi.h                    | 3 +++
 eo/src/mpi/eoMpiAssignmentAlgorithm.h | 2 +-
 eo/src/serial/Object.h                | 2 +-
 eo/src/serial/Parser.h                | 2 +-
 4 files changed, 6 insertions(+), 3 deletions(-)

diff --git a/eo/src/mpi/eoMpi.h b/eo/src/mpi/eoMpi.h
index 23039904..a040e362 100644
--- a/eo/src/mpi/eoMpi.h
+++ b/eo/src/mpi/eoMpi.h
@@ -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,
diff --git a/eo/src/mpi/eoMpiAssignmentAlgorithm.h b/eo/src/mpi/eoMpiAssignmentAlgorithm.h
index d42ec723..e052d8ab 100644
--- a/eo/src/mpi/eoMpiAssignmentAlgorithm.h
+++ b/eo/src/mpi/eoMpiAssignmentAlgorithm.h
@@ -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;
 
diff --git a/eo/src/serial/Object.h b/eo/src/serial/Object.h
index 20fbdbf7..9424f1c4 100644
--- a/eo/src/serial/Object.h
+++ b/eo/src/serial/Object.h
@@ -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 )
             {
diff --git a/eo/src/serial/Parser.h b/eo/src/serial/Parser.h
index 5bcdc597..20f6a1bb 100644
--- a/eo/src/serial/Parser.h
+++ b/eo/src/serial/Parser.h
@@ -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);