From 3a5922da6f9a9e45535f9895359ddd69183ed4e8 Mon Sep 17 00:00:00 2001
From: Christoph Grueninger <christoph.grueninger@iws.uni-stuttgart.de>
Date: Mon, 28 Oct 2013 06:59:20 +0000
Subject: [PATCH] [Doxygen] Improve doxygen documentation.
Add \file commands in mpnc files.
Move comment such that namespaces are not commented but class.
Ignore auto-generated files.
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@11834 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/geomechanics/el2p/el2pindices.hh | 10 ++++------
dumux/implicit/mpnc/energy/mpncindicesenergykinetic.hh | 1 +
dumux/implicit/mpnc/mass/mpncindicesmasskinetic.hh | 1 +
.../implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh | 1 +
dumux/implicit/mpnc/mpncmodelkinetic.hh | 1 +
dumux/implicit/mpnc/mpncpropertieskinetic.hh | 1 +
dumux/implicit/mpnc/mpncpropertydefaultskinetic.hh | 1 +
7 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/dumux/geomechanics/el2p/el2pindices.hh b/dumux/geomechanics/el2p/el2pindices.hh
index e3c39e74ee..7bda6fe95b 100644
--- a/dumux/geomechanics/el2p/el2pindices.hh
+++ b/dumux/geomechanics/el2p/el2pindices.hh
@@ -25,15 +25,16 @@
#ifndef DUMUX_ELASTIC2P_INDICES_HH
#define DUMUX_ELASTIC2P_INDICES_HH
-
#include <dumux/geomechanics/elastic/elasticindices.hh>
#include <dumux/implicit/2p/2pindices.hh>
-
namespace Dumux
{
// \{
+namespace Properties
+{
+
/*!
* \ingroup ElTwoPBoxModel
* \ingroup ImplicitIndices
@@ -41,12 +42,10 @@ namespace Dumux
*
* This class inherits from the TwoPIndices and from the ElasticIndices
*/
-namespace Properties
-{
+
// PVOffset is set to 0 for the TwoPIndices and to 2 for the ElasticIndices since
// the first two primary variables are the primary variables of the two-phase
// model followed by the primary variables of the elastic model
-
template <class TypeTag,
int formulation = 0,
int PVOffset = 2>
@@ -57,4 +56,3 @@ class ElTwoPIndices : public ElasticIndices<PVOffset>, public TwoPIndices<TypeTa
}
#endif
-
diff --git a/dumux/implicit/mpnc/energy/mpncindicesenergykinetic.hh b/dumux/implicit/mpnc/energy/mpncindicesenergykinetic.hh
index 6fc95dcb7b..7a4cef1a1a 100644
--- a/dumux/implicit/mpnc/energy/mpncindicesenergykinetic.hh
+++ b/dumux/implicit/mpnc/energy/mpncindicesenergykinetic.hh
@@ -17,6 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \brief The indices for the thermal non-equilibrium part of the MpNc model.
*/
#ifndef DUMUX_MPNC_INDICES_ENERGY_KINETIC_HH
diff --git a/dumux/implicit/mpnc/mass/mpncindicesmasskinetic.hh b/dumux/implicit/mpnc/mass/mpncindicesmasskinetic.hh
index 15a732590b..2ed88e3516 100644
--- a/dumux/implicit/mpnc/mass/mpncindicesmasskinetic.hh
+++ b/dumux/implicit/mpnc/mass/mpncindicesmasskinetic.hh
@@ -17,6 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \brief The indices for the kinetic mass transfer module of the
* compositional multi-phase model.
*/
diff --git a/dumux/implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh b/dumux/implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh
index 266b87dc8e..4a7534c0fc 100644
--- a/dumux/implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh
+++ b/dumux/implicit/mpnc/mass/mpnclocalresidualmasskinetic.hh
@@ -17,6 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \brief The local residual for the kinetic mass transfer module of
* the compositional multi-phase model.
*/
diff --git a/dumux/implicit/mpnc/mpncmodelkinetic.hh b/dumux/implicit/mpnc/mpncmodelkinetic.hh
index 3303996f56..c82b56895d 100644
--- a/dumux/implicit/mpnc/mpncmodelkinetic.hh
+++ b/dumux/implicit/mpnc/mpncmodelkinetic.hh
@@ -16,6 +16,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \brief This file adds kinetic mass and energy transfer modules to
* the M-phase N-component model.
*/
diff --git a/dumux/implicit/mpnc/mpncpropertieskinetic.hh b/dumux/implicit/mpnc/mpncpropertieskinetic.hh
index 1c36862ee3..db42058cf4 100644
--- a/dumux/implicit/mpnc/mpncpropertieskinetic.hh
+++ b/dumux/implicit/mpnc/mpncpropertieskinetic.hh
@@ -17,6 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \brief This file declares and defines the properties required by
* the kinetic modules the M-phase N-component model.
*/
diff --git a/dumux/implicit/mpnc/mpncpropertydefaultskinetic.hh b/dumux/implicit/mpnc/mpncpropertydefaultskinetic.hh
index 631743d267..a8d9a4296b 100644
--- a/dumux/implicit/mpnc/mpncpropertydefaultskinetic.hh
+++ b/dumux/implicit/mpnc/mpncpropertydefaultskinetic.hh
@@ -17,6 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \brief This file declares and defines the properties required by
* the kinetic modules the M-phase N-component model.
*/
--
GitLab