From 5a2cf38d910d0cad31b8df3e7afa84c7bd12a72c Mon Sep 17 00:00:00 2001
From: Johannes Hommel <johannes.hommel@iws.uni-stuttgart.de>
Date: Tue, 19 Dec 2017 11:34:21 +0100
Subject: [PATCH] [doxygen] added 2pnc and 2pncmin tests
---
doc/doxygen/modules.txt | 2 ++
.../2pnc/implicit/fuelcellproblem.hh | 7 +++++--
.../2pnc/implicit/fuelcellspatialparams.hh | 8 ++++++--
.../2pncmin/implicit/dissolutionproblem.hh | 7 +++++--
.../2pncmin/implicit/dissolutionspatialparams.hh | 13 ++++++++++---
5 files changed, 28 insertions(+), 9 deletions(-)
diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt
index e742d9fec9..4ad12ff178 100644
--- a/doc/doxygen/modules.txt
+++ b/doc/doxygen/modules.txt
@@ -194,9 +194,11 @@
*/
/*! \ingroup BenchmarksAndTests
* \defgroup TwoPNCTests 2pnc (two phase, n-component) benchmarks and tests
+ * TwoPNCTests contain a fuel cell test problem using the TwoPNCModel. The files are listed below.
*/
/*! \ingroup BenchmarksAndTests
* \defgroup TwoPNCMinTests 2pncmin (two phase, n-component mineralization) benchmarks and tests
+ * TwoPNCMinTests contain a salt dissolution test problem using the TwoPNCMinModel. The files are listed below.
*/
/*! \ingroup BenchmarksAndTests
* \defgroup ThreePTests 3p (three phase) benchmarks and tests
diff --git a/test/porousmediumflow/2pnc/implicit/fuelcellproblem.hh b/test/porousmediumflow/2pnc/implicit/fuelcellproblem.hh
index c1a1c67755..541bf3b69a 100644
--- a/test/porousmediumflow/2pnc/implicit/fuelcellproblem.hh
+++ b/test/porousmediumflow/2pnc/implicit/fuelcellproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup TwoPNCTests
* \brief Definition of a problem for water management in PEM fuel cells.
*/
#ifndef DUMUX_FUELCELL_PROBLEM_HH
@@ -35,7 +35,10 @@
namespace Dumux
{
-
+/*!
+ * \ingroup TwoPNCTests
+ * \brief Definition of a problem for water management in PEM fuel cells.
+ */
template <class TypeTag>
class FuelCellProblem;
diff --git a/test/porousmediumflow/2pnc/implicit/fuelcellspatialparams.hh b/test/porousmediumflow/2pnc/implicit/fuelcellspatialparams.hh
index 8f6e6f18d6..27084bbe36 100644
--- a/test/porousmediumflow/2pnc/implicit/fuelcellspatialparams.hh
+++ b/test/porousmediumflow/2pnc/implicit/fuelcellspatialparams.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup TwoPNCTests
* \brief Definition of the spatial parameters for the fuel cell
* problem which uses the isothermal/non-insothermal 2pnc box model
*/
@@ -34,7 +34,11 @@
namespace Dumux
{
-
+/*!
+ * \ingroup TwoPNCTests
+ * \brief Definition of the spatial parameters for the fuel cell
+ * problem which uses the isothermal/non-insothermal 2pnc box model
+ */
//forward declaration
template<class TypeTag>
class FuelCellSpatialParams;
diff --git a/test/porousmediumflow/2pncmin/implicit/dissolutionproblem.hh b/test/porousmediumflow/2pncmin/implicit/dissolutionproblem.hh
index a901fe2fbe..328918f4c9 100644
--- a/test/porousmediumflow/2pncmin/implicit/dissolutionproblem.hh
+++ b/test/porousmediumflow/2pncmin/implicit/dissolutionproblem.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup TwoPNCMinTests
* \brief Problem where water is injected in a for flushing precipitated salt clogging a gas reservoir.
*/
#ifndef DUMUX_DISSOLUTION_PROBLEM_HH
@@ -35,7 +35,10 @@
namespace Dumux
{
-
+/*!
+ * \ingroup TwoPNCMinTests
+ * \brief Problem where water is injected in a for flushing precipitated salt clogging a gas reservoir.
+ */
template <class TypeTag>
class DissolutionProblem;
diff --git a/test/porousmediumflow/2pncmin/implicit/dissolutionspatialparams.hh b/test/porousmediumflow/2pncmin/implicit/dissolutionspatialparams.hh
index c82c0b3a9d..841e2f7963 100644
--- a/test/porousmediumflow/2pncmin/implicit/dissolutionspatialparams.hh
+++ b/test/porousmediumflow/2pncmin/implicit/dissolutionspatialparams.hh
@@ -16,6 +16,12 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
+/*!
+ * \file
+ * \ingroup TwoPNCMinTests
+ * \brief Spatial parameters for the dissolution problem
+ * where water is injected in a for flushing precipitated salt clogging a gas reservoir.
+ */
#ifndef DUMUX_INJECTION_SPATIAL_PARAMETERS_HH
#define DUMUX_INJECTION_SPATIAL_PARAMETERS_HH
@@ -53,9 +59,10 @@ public:
} // end namespace Properties
-/**
- * \brief Definition of the spatial parameters for the brine-co2 problem
- *
+/*!
+ * \ingroup TwoPNCMinTests
+ * \brief Spatial parameters for the dissolution problem
+ * where water is injected in a for flushing precipitated salt clogging a gas reservoir.
*/
template<class TypeTag>
class DissolutionSpatialparams : public FVSpatialParams<TypeTag>
--
GitLab