improved documentation of MPIHelper & CollectiveCommunication

[[Imported from SVN: r4968]]

common/collectivecommunication.hh

@@ -9,10 +9,25 @@
 
 #include "exceptions.hh"
 
+/*! \defgroup ParallelCommunication Parallel Communication
+   \ingroup Common
+
+   Dune offers an abstraction to the basic methods of parallel
+   communication. It allows to switch parallel features on and of,
+   without changing the code.
+
+ */
+
 namespace Dune
 {
   /*! @brief Collective communication interface and sequential default implementation
 
+     CollectiveCommunication offers an abstraction to the basic methods
+     of parallel communication, following the message-passing
+     paradigm. It allows to switch parallel features on and of, without
+     changing the code. Currently only MPI and sequential code are
+     supported.
+
      A CollectiveCommunication object is returned by all grids (also
      the sequential ones) in order to allow code to be written in
      a transparent way for sequential and parallel grids.
@@ -29,7 +44,7 @@ namespace Dune
      is not visible in the interface, i.e. Dune grid implementations
      are not restricted to MPI.
 
-     \ingroup GICollectiveCommunication
+     \ingroup ParallelCommunication
    */
   template<typename C>
   class CollectiveCommunication

common/mpicollectivecommunication.hh

@@ -16,7 +16,6 @@
 // MPI header
 #include <mpi.h>
 
-
 namespace Dune
 {
   //=======================================================
@@ -183,7 +182,7 @@ namespace Dune
   //=======================================================
 
   /*! \brief Specialization of CollectiveCommunication for MPI
-        \ingroup GICollectiveCommunication
+        \ingroup ParallelCommunication
    */
   template<>
   class CollectiveCommunication<MPI_Comm>

common/mpihelper.hh

@@ -16,6 +16,7 @@ namespace Dune
   /**
    * @file
    * @brief This file contains helpers for dealing with MPI.
+   * @ingroup ParallelCommunication
    *
    * Basically there are two helpers available:
    * <dl>
@@ -126,6 +127,7 @@ namespace Dune
 #if HAVE_MPI
   /**
    * @brief A real mpi helper.
+   * @ingroup ParallelCommunication
    *
    * This helper should be used for parallel programs.
    */
@@ -215,7 +217,10 @@ namespace Dune
 #else
   // We do not have MPI therefore FakeMPIHelper
   // is the MPIHelper
-  /** @brief If no MPI is available FakeMPIHelper becomes the MPIHelper */
+  /**
+   * @brief If no MPI is available FakeMPIHelper becomes the MPIHelper
+   * @ingroup ParallelCommunication
+   */
   typedef FakeMPIHelper MPIHelper;
 
 #endif