From 80646fe2afd29a3450ceba46c0b92ba07eb78429 Mon Sep 17 00:00:00 2001
From: Timo Koch <timo.koch@iws.uni-stuttgart.de>
Date: Wed, 20 Dec 2017 13:53:08 +0100
Subject: [PATCH] [doc] Improve documentation of folder parallel
---
doc/doxygen/modules.txt | 2 +-
dumux/parallel/vertexhandles.hh | 13 +++++++------
2 files changed, 8 insertions(+), 7 deletions(-)
diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt
index 1f3f21bb43..c939ebdcaf 100644
--- a/doc/doxygen/modules.txt
+++ b/doc/doxygen/modules.txt
@@ -428,5 +428,5 @@
/* ***************** Parallel ******************/
/*!
* \defgroup Parallel Parallel
- * TODO: Doc me in modules.txt!
+ * \brief Helpers for parallel runs with MPI
*/
diff --git a/dumux/parallel/vertexhandles.hh b/dumux/parallel/vertexhandles.hh
index 30abd11214..dfbb61dcd7 100644
--- a/dumux/parallel/vertexhandles.hh
+++ b/dumux/parallel/vertexhandles.hh
@@ -18,9 +18,9 @@
*****************************************************************************/
/*!
* \file
- *
- * \brief Provides data handles for parallel communication which
- * operate on vertices
+ * \ingroup Parallel
+ * \brief Provides data handles for parallel communication which operate on vertices
+ * \note This is useful for schemes with degrees of freedom on vertices (box scheme)
*/
#ifndef DUMUX_VERTEX_HANDLES_HH
#define DUMUX_VERTEX_HANDLES_HH
@@ -28,9 +28,10 @@
#include <dune/grid/common/datahandleif.hh>
-namespace Dumux
-{
+namespace Dumux {
+
/*!
+ * \ingroup Parallel
* \brief Data handle for parallel communication which sums up all
* values are attached to vertices
*/
@@ -206,6 +207,6 @@ private:
Container &container_;
};
-}
+} // end namespace Dumux
#endif
--
GitLab