From 57c533d8bec4689b8475e5fe8bc4449c04444aa5 Mon Sep 17 00:00:00 2001
From: Katharina Heck <katharina.heck@iws.uni-stuttgart.de>
Date: Wed, 21 Nov 2018 14:13:42 +0100
Subject: [PATCH] [cleanup] docu
---
dumux/material/fluidmatrixinteractions/mp/mpadapter.hh | 2 ++
dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh | 2 ++
dumux/material/fluidstates/compositional.hh | 2 --
dumux/material/fluidstates/immiscible.hh | 2 --
4 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/dumux/material/fluidmatrixinteractions/mp/mpadapter.hh b/dumux/material/fluidmatrixinteractions/mp/mpadapter.hh
index 2754859c6d..a9294a4330 100644
--- a/dumux/material/fluidmatrixinteractions/mp/mpadapter.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/mpadapter.hh
@@ -53,6 +53,7 @@ public:
* \param values Container for the return values
* \param params Array of parameters
* \param state Fluidstate
+ * \param wPhaseIdx index of the wetting phase
*/
template <class ContainerT, class FluidState>
static void capillaryPressures(ContainerT &values,
@@ -73,6 +74,7 @@ public:
* \param values Container for the return values
* \param params Array of parameters
* \param state Fluidstate
+ * \param wPhaseIdx index of the wetting phase
*/
template <class ContainerT, class FluidState>
static void relativePermeabilities(ContainerT &values,
diff --git a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
index f92c044bf7..5a5c5f0ddf 100644
--- a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
@@ -61,6 +61,7 @@ public:
* \param values Container for the return values
* \param params Array of Parameters
* \param state The fluid state
+ * \param wPhaseIdx index of the wetting phase
*/
template <class ContainerT, class FluidState>
static void capillaryPressures(ContainerT &values,
@@ -81,6 +82,7 @@ public:
* \param values Container for the return values
* \param params Array of Parameters
* \param state The fluid state
+ * \param wPhaseIdx index of the wetting phase
*/
template <class ContainerT, class FluidState>
static void relativePermeabilities(ContainerT &values,
diff --git a/dumux/material/fluidstates/compositional.hh b/dumux/material/fluidstates/compositional.hh
index b15c708aed..ba3e7dd19d 100644
--- a/dumux/material/fluidstates/compositional.hh
+++ b/dumux/material/fluidstates/compositional.hh
@@ -73,8 +73,6 @@ public:
/*!
* \brief Returns the index of the wetting phase in the
* fluid-solid configuration (for porous medium systems).
- *
- * \param phaseIdx the index of the phase
*/
int wettingPhase() const { return wPhaseIdx_; }
diff --git a/dumux/material/fluidstates/immiscible.hh b/dumux/material/fluidstates/immiscible.hh
index 4365653fc8..f041a43c15 100644
--- a/dumux/material/fluidstates/immiscible.hh
+++ b/dumux/material/fluidstates/immiscible.hh
@@ -68,8 +68,6 @@ public:
/*!
* \brief Returns the index of the wetting phase in the
* fluid-solid configuration (for porous medium systems).
- *
- * \param phaseIdx the index of the phase
*/
int wettingPhase() const { return wPhaseIdx_; }
--
GitLab