From d5712d3aae6a0d6f082ffc877dc21f73b8262a83 Mon Sep 17 00:00:00 2001
From: Kilian Weishaupt <kilian.weishaupt@iws.uni-stuttgart.de>
Date: Wed, 23 Mar 2016 17:32:05 +0100
Subject: [PATCH] [doxygen] Fix missing or wrong parameter descriptions

---
 dumux/material/chemistry/electrochemistry/electrochemistry.hh | 2 +-
 .../material/chemistry/electrochemistry/electrochemistryni.hh | 2 +-
 dumux/material/components/brine.hh                            | 1 +
 dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh   | 4 ++--
 .../fluidmatrixinteractions/3p/regularizedparkervangen3p.hh   | 4 ++--
 dumux/multidomain/2cnistokes2p2cni/problem.hh                 | 2 +-
 dumux/multidomain/2cstokes2p2c/problem.hh                     | 2 +-
 dumux/porousmediumflow/2pdfm/implicit/volumevariables.hh      | 4 +++-
 8 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/dumux/material/chemistry/electrochemistry/electrochemistry.hh b/dumux/material/chemistry/electrochemistry/electrochemistry.hh
index c67e8b5559..0c9da48a0e 100644
--- a/dumux/material/chemistry/electrochemistry/electrochemistry.hh
+++ b/dumux/material/chemistry/electrochemistry/electrochemistry.hh
@@ -109,7 +109,7 @@ public:
     * \brief Calculates reaction sources with an electrochemical model approach.
     *
     * \param values The primary variable vector
-    * \param volVars The volume variables
+    * \param currentDensity The current density
     *
     * For this method, the \a values parameter stores source values
     */
diff --git a/dumux/material/chemistry/electrochemistry/electrochemistryni.hh b/dumux/material/chemistry/electrochemistry/electrochemistryni.hh
index f332cdf98f..8f4c29b433 100644
--- a/dumux/material/chemistry/electrochemistry/electrochemistryni.hh
+++ b/dumux/material/chemistry/electrochemistry/electrochemistryni.hh
@@ -84,7 +84,7 @@ public:
     * \brief Calculates reaction sources with an electrochemical model approach.
     *
     * \param values The primary variable vector
-    * \param volVars The volume variables
+    * \param currentDensity The current density
     *
     * For this method, the \a values parameter stores source values
     */
diff --git a/dumux/material/components/brine.hh b/dumux/material/components/brine.hh
index c75eaf0172..6dbb4b1ebb 100644
--- a/dumux/material/components/brine.hh
+++ b/dumux/material/components/brine.hh
@@ -181,6 +181,7 @@ public:
      *
      * \param temperature temperature of component in \f$\mathrm{[K]}\f$
      * \param pressure pressure of component in \f$\mathrm{[Pa]}\f$
+     * \param salinity salinity in\f$\mathrm{[kg/kg]}\f$
      *
      * See:
      *
diff --git a/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh b/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
index 8d9cf902c3..7dbd5d3144 100644
--- a/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/parkervangen3p.hh
@@ -144,7 +144,7 @@ public:
      * \brief Returns the partial derivative of the capillary
      *        pressure to the effective saturation.
      * \param params Array of parameters
-     * \param sw Wetting liquid saturation
+     * \param swe Effective wetting liquid saturation
     */
     DUNE_DEPRECATED_MSG("dpc_dsw(const Params &params, const Scalar swe) is deprecated. Use dpc_dswe(const Params &params, const Scalar swe) instead.")
     static Scalar dpc_dsw(const Params &params, const Scalar swe)
@@ -156,7 +156,7 @@ public:
      * \brief Returns the partial derivative of the capillary
      *        pressure to the effective saturation.
      * \param params Array of parameters
-     * \param sw Wetting liquid saturation
+     * \param swe Effective wetting liquid saturation
     */
     static Scalar dpc_dswe(const Params &params, const Scalar swe)
     {
diff --git a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
index cab93c2b26..9f7394a81e 100644
--- a/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
+++ b/dumux/material/fluidmatrixinteractions/3p/regularizedparkervangen3p.hh
@@ -274,7 +274,7 @@ public:
      * \brief Returns the partial derivative of the capillary
      *        pressure to the effective saturation.
      * \param params Array of parameters
-     * \param sw Wetting liquid saturation
+     * \param swe Wetting liquid saturation
     */
     DUNE_DEPRECATED_MSG("dpc_dsw(const Params &params, Scalar swe) is deprecated. Use dpc_dswe(const Params &params, Scalar swe) instead.")
     static Scalar dpc_dsw(const Params &params, Scalar swe)
@@ -286,7 +286,7 @@ public:
      * \brief Returns the partial derivative of the capillary
      *        pressure to the effective saturation.
      * \param params Array of parameters
-     * \param sw Wetting liquid saturation
+     * \param swe Effective wetting liquid saturation
     */
     static Scalar dpc_dswe(const Params &params, Scalar swe)
     {
diff --git a/dumux/multidomain/2cnistokes2p2cni/problem.hh b/dumux/multidomain/2cnistokes2p2cni/problem.hh
index 05e2420fc5..0b87fbfb5d 100644
--- a/dumux/multidomain/2cnistokes2p2cni/problem.hh
+++ b/dumux/multidomain/2cnistokes2p2cni/problem.hh
@@ -61,7 +61,7 @@ public:
      * \brief Returns the temperature gradient through the boundary layer
      *
      * \param cParams a parameter container
-     * \param scvIdx1 The local index of the sub-control volume of the Stokes domain
+     * \param scvIdx The local index of the sub-control volume of the Stokes domain
      */
     template<typename CParams>
     Scalar evalBoundaryLayerTemperatureGradient(CParams cParams, const int scvIdx) const
diff --git a/dumux/multidomain/2cstokes2p2c/problem.hh b/dumux/multidomain/2cstokes2p2c/problem.hh
index f6739e16df..47673ccacf 100644
--- a/dumux/multidomain/2cstokes2p2c/problem.hh
+++ b/dumux/multidomain/2cstokes2p2c/problem.hh
@@ -135,7 +135,7 @@ public:
      *
      * \param cParams a parameter container
      * \param scvIdx1 The local index of the sub-control volume of the Stokes domain
-     * \param scvIdx1 The local index of the sub-control volume of the Darcy domain
+     * \param scvIdx2 The local index of the sub-control volume of the Darcy domain
      */
     template<typename CParams>
     Scalar evalMassTransferCoefficient(CParams cParams, const int scvIdx1, const int scvIdx2) const
diff --git a/dumux/porousmediumflow/2pdfm/implicit/volumevariables.hh b/dumux/porousmediumflow/2pdfm/implicit/volumevariables.hh
index aba771f9d0..ce4678a94a 100644
--- a/dumux/porousmediumflow/2pdfm/implicit/volumevariables.hh
+++ b/dumux/porousmediumflow/2pdfm/implicit/volumevariables.hh
@@ -179,7 +179,9 @@ public:
     /*!
      * \brief Extended capillary pressure saturation interface condition
      *
-     * \param materialParamsMatrix the material law o calculate the sw as inverse of capillary pressure function
+     * \param priVars Primary variables
+     * \param materialParamsMatrix the material law to calculate the sw as inverse of capillary pressure function
+     * \param materialParamsFracture the material law to calculate the sw as inverse of capillary pressure function
      *
      * This method is called by updateFracture
      */
-- 
GitLab