mDocumentation of eo::mpi classes.

eo/src/mpi/eoTerminateJob.h

@@ -1,3 +1,24 @@
+/*
+(c) Thales group, 2012
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation;
+    version 2 of the License.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You should have received a copy of the GNU Lesser General Public
+    License along with this library; if not, write to the Free Software
+    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+Contact: http://eodev.sourceforge.net
+
+Authors:
+    Benjamin Bouvier <benjamin.bouvier@gmail.com>
+*/
 # ifndef __EO_TERMINATE_H__
 # define __EO_TERMINATE_H__
 
@@ -7,6 +28,14 @@ namespace eo
 {
     namespace mpi
     {
+        /**
+         * @ingroup Parallel
+         * @{
+         */
+
+        /**
+         * @brief Send task functor which does nothing.
+         */
         struct DummySendTaskFunction : public SendTaskFunction<void>
         {
             void operator()( int _ )
@@ -15,6 +44,9 @@ namespace eo
             }
         };
 
+        /**
+         * @brief Handle response functor which does nothing.
+         */
         struct DummyHandleResponseFunction : public HandleResponseFunction<void>
         {
             void operator()( int _ )
@@ -23,6 +55,9 @@ namespace eo
             }
         };
 
+        /**
+         * @brief Process task functor which does nothing.
+         */
         struct DummyProcessTaskFunction : public ProcessTaskFunction<void>
         {
             void operator()()
@@ -31,6 +66,9 @@ namespace eo
             }
         };
 
+        /**
+         * @brief Is finished functor which returns true everytime.
+         */
         struct DummyIsFinishedFunction : public IsFinishedFunction<void>
         {
             bool operator()()
@@ -39,6 +77,9 @@ namespace eo
             }
         };
 
+        /**
+         * @brief Job store containing all dummy functors and containing no data.
+         */
         struct DummyJobStore : public JobStore<void>
         {
             using JobStore<void>::_stf;
@@ -61,11 +102,20 @@ namespace eo
             void* data() { return 0; }
         };
 
+        /**
+         * @brief Job to run after a Multi Job, so as to indicate that every workers should terminate.
+         */
         struct EmptyJob : public OneShotJob<void>
         {
+            /**
+             * @brief Main EmptyJob ctor
+             *
+             * @param algo Assignment (scheduling) algorithm used.
+             * @param masterRank The rank of the master process.
+             */
             EmptyJob( AssignmentAlgorithm& algo, int masterRank ) :
                 OneShotJob<void>( algo, masterRank, *(new DummyJobStore) )
-                // FIXME memory leak => will be corrected by using const correctness
+                // FIXME memory leak, meaningless but present
             {
                 // empty
             }
@@ -79,6 +129,10 @@ namespace eo
                 }
             }
         };
+
+        /**
+         * @}
+         */
     }
 }