From 3d980e172880c70b41393716176699c43013191d Mon Sep 17 00:00:00 2001
From: Gabriele Seitz <gabriele.seitz@iws.uni-stuttgart.de>
Date: Fri, 3 Mar 2017 11:57:44 +0100
Subject: [PATCH] [doxygen] fix some small errors of doxyerr.log
fix typos, named correct arguments of function calls, etc.
---
doc/doxygen/Doxylocal | 2 +-
dumux/common/eigenvalues.hh | 2 +-
dumux/implicit/adaptive/adaptionhelper.hh | 5 +++--
dumux/io/ploteffectivediffusivitymodel.hh | 2 +-
dumux/io/plotthermalconductivitymodel.hh | 4 +++-
dumux/multidomain/newtoncontroller.hh | 2 +-
dumux/porousmediumflow/2p/implicit/adaptionhelper.hh | 3 ++-
7 files changed, 12 insertions(+), 8 deletions(-)
diff --git a/doc/doxygen/Doxylocal b/doc/doxygen/Doxylocal
index a6f2b721c5..fcf6e7271f 100644
--- a/doc/doxygen/Doxylocal
+++ b/doc/doxygen/Doxylocal
@@ -1,5 +1,5 @@
# This file contains local changes to the doxygen configuration
-# please us '+=' to add file/directories to the lists
+# please use '+=' to add file/directories to the lists
PREDEFINED += "NEW_PROP_TAG(name)=Property tag name" \
"NEW_TYPE_TAG(name)=Type tag name" \
diff --git a/dumux/common/eigenvalues.hh b/dumux/common/eigenvalues.hh
index 6746502049..4241ac2d93 100644
--- a/dumux/common/eigenvalues.hh
+++ b/dumux/common/eigenvalues.hh
@@ -56,7 +56,7 @@ double calcOffDiagonalNorm(Matrix& matrix)
}
/*!
- * \briefFunction to calculate eigenvalues of n x n matrices
+ * \brief Function to calculate eigenvalues of n x n matrices
*
* \param eigVel Vector for storing the eigenvalues
* \param matrix n x n matrices for which eigenvalues have to be calculated
diff --git a/dumux/implicit/adaptive/adaptionhelper.hh b/dumux/implicit/adaptive/adaptionhelper.hh
index 36ddbb7eec..b74bad049b 100644
--- a/dumux/implicit/adaptive/adaptionhelper.hh
+++ b/dumux/implicit/adaptive/adaptionhelper.hh
@@ -67,9 +67,10 @@ public:
//! Constructs an adaptive helper object
/**
* In addition to providing a storage object for cell-centered Methods, this class provides
- * mapping functionality to adapt the grid.
+ * mapping functionality to adapt the grid. It uses gridView, a DUNE gridview object corresponding
+ * to diffusion and transport equation
*
- * @param gridView a DUNE gridview object corresponding to diffusion and transport equation
+ * @param problem The current problem
*/
ImplicitAdaptionHelper(Problem& problem)
{}
diff --git a/dumux/io/ploteffectivediffusivitymodel.hh b/dumux/io/ploteffectivediffusivitymodel.hh
index 70073ae5be..2807bfebcc 100644
--- a/dumux/io/ploteffectivediffusivitymodel.hh
+++ b/dumux/io/ploteffectivediffusivitymodel.hh
@@ -65,7 +65,7 @@ public:
* \brief Add a effective diffusion factor-saturation data set to the plot
*
* \param gnuplot The gnuplot interface
- * \param params The material law parameters
+ * \param porosity The porosity
* \param lowerSat Minimum x-value for data set
* \param upperSat Maximum x-value for data set
* \param curveName Name of the data set
diff --git a/dumux/io/plotthermalconductivitymodel.hh b/dumux/io/plotthermalconductivitymodel.hh
index db4963bfb1..58f9ae8f76 100644
--- a/dumux/io/plotthermalconductivitymodel.hh
+++ b/dumux/io/plotthermalconductivitymodel.hh
@@ -109,7 +109,9 @@ public:
* \brief Add a effective thermal conductivity-saturation curve to the plot
*
* \param gnuplot The gnuplot interface
- * \param params The material law parameters
+ * \param porosity The porosity
+ * \param rhoSolid The solid density
+ * \param lambdaSolid Thermal conductivity of the solid
* \param lowerSat Minimum x-value for data set
* \param upperSat Maximum x-value for data set
* \param curveName Name of the data set
diff --git a/dumux/multidomain/newtoncontroller.hh b/dumux/multidomain/newtoncontroller.hh
index 1fefd9ac3d..7fa9fa5fab 100644
--- a/dumux/multidomain/newtoncontroller.hh
+++ b/dumux/multidomain/newtoncontroller.hh
@@ -97,7 +97,7 @@ public:
<< std::endl;
}
- //! \copydoc ParentType::newtonUpdateShift()
+ //! \copydoc NewtonController::newtonUpdateShift()
void newtonUpdateShift(const SolutionVector &uLastIter,
const SolutionVector &deltaU)
{
diff --git a/dumux/porousmediumflow/2p/implicit/adaptionhelper.hh b/dumux/porousmediumflow/2p/implicit/adaptionhelper.hh
index c69cba7691..5bef853839 100644
--- a/dumux/porousmediumflow/2p/implicit/adaptionhelper.hh
+++ b/dumux/porousmediumflow/2p/implicit/adaptionhelper.hh
@@ -92,7 +92,7 @@ private:
public:
//! Constructs an adaption helper object
/**
- * @param gridView a DUNE gridview object
+ * @param problem The current problem
*/
TwoPAdaptionHelper(Problem& problem) : ParentType(problem), adaptionMap_(problem.grid(), 0)
{
@@ -479,6 +479,7 @@ public:
*
* \param adaptedValues Container for model-specific values to be adapted
* \param u The variables to be stored
+ * \param scvIdx The SCV (sub-control-volume) index
*/
static void setAdaptionValues(AdaptedValues& adaptedValues, PrimaryVariables& u, int scvIdx)
{
--
GitLab