From 899cc5a86fb0d28720360953f10c8f92f3f41208 Mon Sep 17 00:00:00 2001
From: Melanie Darcis <mdarcis@gmx.de>
Date: Thu, 11 Nov 2010 15:01:37 +0000
Subject: [PATCH] doc
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@4662 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
tutorial/tutorialproblem_coupled.hh | 11 +++++++++++
tutorial/tutorialspatialparameters_coupled.hh | 13 ++++++++++++-
2 files changed, 23 insertions(+), 1 deletion(-)
diff --git a/tutorial/tutorialproblem_coupled.hh b/tutorial/tutorialproblem_coupled.hh
index 5439a48946..bf94e53b54 100644
--- a/tutorial/tutorialproblem_coupled.hh
+++ b/tutorial/tutorialproblem_coupled.hh
@@ -14,6 +14,11 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief Tutorial problem for a fully coupled twophase box model.
+ */
#ifndef DUMUX_TUTORIALPROBLEM_COUPLED_HH
#define DUMUX_TUTORIALPROBLEM_COUPLED_HH
@@ -85,6 +90,12 @@ SET_PROP(TutorialProblemCoupled, SpatialParameters) /*@\label{tutorial-coupled:s
SET_BOOL_PROP(TutorialProblemCoupled, EnableGravity, false); /*@\label{tutorial-coupled:gravity}@*/
}
+/*!
+* \ingroup TwoPBoxModel
+*
+* \brief Tutorial problem for a fully coupled twophase box model.
+*/
+
// Definition of the actual problem
template <class TypeTag>
class TutorialProblemCoupled : public TwoPProblem<TypeTag> /*@\label{tutorial-coupled:def-problem}@*/
diff --git a/tutorial/tutorialspatialparameters_coupled.hh b/tutorial/tutorialspatialparameters_coupled.hh
index a0de7fcb9f..88c6161670 100644
--- a/tutorial/tutorialspatialparameters_coupled.hh
+++ b/tutorial/tutorialspatialparameters_coupled.hh
@@ -13,6 +13,12 @@
* *
* This program is distributed WITHOUT ANY WARRANTY. *
*****************************************************************************/
+/*!
+ * \file
+ *
+ * \brief The spatial parameters for the fully coupled tutorial problem
+ * which uses the twophase box model.
+ */
#ifndef TUTORIALSPATIALPARAMETERS_COUPLED_HH
#define TUTORIALSPATIALPARAMETERS_COUPLED_HH
@@ -25,7 +31,12 @@
namespace Dumux
{
-
+/*!
+ * \ingroup TwoPBoxModel
+ *
+ * \brief The spatial parameters for the fully coupled tutorial problem
+ * which uses the twophase box model.
+ */
template<class TypeTag>
class TutorialSpatialParametersCoupled: public BoxSpatialParameters<TypeTag> /*@\label{tutorial-coupled:tutorialSpatialParameters}@*/
{
--
GitLab