From 238bb8b4a242a1c51507d3f0f3cc24ff5e63fd05 Mon Sep 17 00:00:00 2001
From: Katharina Heck <katharina.heck@iws.uni-stuttgart.de>
Date: Thu, 21 Dec 2017 10:28:42 +0100
Subject: [PATCH] [fix] mpnc docu
---
dumux/porousmediumflow/mpnc/indices.hh | 3 +--
dumux/porousmediumflow/mpnc/localresidual.hh | 2 +-
dumux/porousmediumflow/mpnc/model.hh | 5 +----
dumux/porousmediumflow/mpnc/volumevariables.hh | 3 +--
dumux/porousmediumflow/mpnc/vtkoutputfields.hh | 3 ++-
5 files changed, 6 insertions(+), 10 deletions(-)
diff --git a/dumux/porousmediumflow/mpnc/indices.hh b/dumux/porousmediumflow/mpnc/indices.hh
index 84eb9a4c5f..387dc0e580 100644
--- a/dumux/porousmediumflow/mpnc/indices.hh
+++ b/dumux/porousmediumflow/mpnc/indices.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MPNCModel
* \brief The primary variable and equation indices for the MpNc model.
*/
#ifndef DUMUX_MPNC_INDICES_HH
@@ -30,7 +31,6 @@ namespace Dumux
/*!
* \ingroup MPNCModel
- * \ingroup ImplicitIndices
* \brief Enumerates the formulations which the MpNc model accepts.
*/
struct MpNcPressureFormulation
@@ -43,7 +43,6 @@ struct MpNcPressureFormulation
/*!
* \ingroup MPNCModel
- * \ingroup ImplicitIndices
* \brief The primary variable and equation indices for the MpNc model.
*/
template <class TypeTag, int BasePVOffset = 0>
diff --git a/dumux/porousmediumflow/mpnc/localresidual.hh b/dumux/porousmediumflow/mpnc/localresidual.hh
index 068cbbc931..82cd7814ac 100644
--- a/dumux/porousmediumflow/mpnc/localresidual.hh
+++ b/dumux/porousmediumflow/mpnc/localresidual.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MPNCModel
* \brief MpNc specific details needed to approximately calculate the local
* defect in the fully implicit scheme.
*
@@ -32,7 +33,6 @@ namespace Dumux
{
/*!
* \ingroup MPNCModel
- * \ingroup ImplicitLocalResidual
* \brief MpNc specific details needed to approximately calculate the local
* defect in the fully implicit scheme.
*
diff --git a/dumux/porousmediumflow/mpnc/model.hh b/dumux/porousmediumflow/mpnc/model.hh
index 3385417553..9dcb351516 100644
--- a/dumux/porousmediumflow/mpnc/model.hh
+++ b/dumux/porousmediumflow/mpnc/model.hh
@@ -115,10 +115,7 @@
#include "localresidual.hh"
/*!
- * \ingroup Properties
- * \ingroup ImplicitProperties
- * \ingroup BoxMpNcModel
- * \file
+ * \ingroup \ingroup MPNCModel
* \brief Defines the properties required for the MpNc fully implicit model.
*/
namespace Dumux
diff --git a/dumux/porousmediumflow/mpnc/volumevariables.hh b/dumux/porousmediumflow/mpnc/volumevariables.hh
index 217e63e5f4..c13d3d0a07 100644
--- a/dumux/porousmediumflow/mpnc/volumevariables.hh
+++ b/dumux/porousmediumflow/mpnc/volumevariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- *
+ * \ingroup MPNCModel
* \brief Contains the secondary variables (Quantities which are
* constant within a finite volume) of the MpNc model.
*/
@@ -38,7 +38,6 @@ namespace Dumux
{
/*!
* \ingroup MPNCModel
- * \ingroup ImplicitVolumeVariables
* \brief Contains the quantities which are constant within a
* finite volume in the MpNc model.
*/
diff --git a/dumux/porousmediumflow/mpnc/vtkoutputfields.hh b/dumux/porousmediumflow/mpnc/vtkoutputfields.hh
index fa3e9ae90e..f3c8c5b73b 100644
--- a/dumux/porousmediumflow/mpnc/vtkoutputfields.hh
+++ b/dumux/porousmediumflow/mpnc/vtkoutputfields.hh
@@ -18,6 +18,7 @@
*****************************************************************************/
/*!
* \file
+ * \ingroup MPNCModel
* \brief Adds vtk output fields specific to the twop model
*/
#ifndef DUMUX_MPNC_VTK_OUTPUT_FIELDS_HH
@@ -27,7 +28,7 @@ namespace Dumux
{
/*!
- * \ingroup TwoP, InputOutput
+ * \ingroup MPNCModel
* \brief Adds vtk output fields specific to the twop model
*/
template<class TypeTag>
--
GitLab