From 53a78a020314794da7696dfab5944a97fbee5343 Mon Sep 17 00:00:00 2001
From: Melanie Lipp <melanie.lipp@iws.uni-stuttgart.de>
Date: Wed, 7 Apr 2021 14:38:30 +0200
Subject: [PATCH] [doc][doxygen] Reduce error log to what we had for release
3.3.
---
dumux/common/variables.hh | 2 +-
dumux/flux/shallowwaterviscousflux.hh | 2 +-
dumux/material/components/h2o.hh | 3 ++-
dumux/multidomain/newtonsolver.hh | 2 +-
dumux/nonlinear/newtonsolver.hh | 1 +
dumux/timestepping/multistagetimestepper.hh | 2 +-
6 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/dumux/common/variables.hh b/dumux/common/variables.hh
index 51b3ecefeb..7f59ada898 100644
--- a/dumux/common/variables.hh
+++ b/dumux/common/variables.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup Common
- * \copydoc Dumux::Variables
+ * \copydoc Dumux::Experimental::Variables
*/
#ifndef DUMUX_COMMON_VARIABLES_HH
#define DUMUX_COMMON_VARIABLES_HH
diff --git a/dumux/flux/shallowwaterviscousflux.hh b/dumux/flux/shallowwaterviscousflux.hh
index 97c8610e93..a3b22fdd06 100644
--- a/dumux/flux/shallowwaterviscousflux.hh
+++ b/dumux/flux/shallowwaterviscousflux.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup Flux
- * \copydoc Dumux::ShallowWaterViscousMomentumFlux
+ * \copydoc Dumux::ShallowWaterViscousFlux
*/
#ifndef DUMUX_FLUX_SHALLOW_WATER_VISCOUS_FLUX_HH
#define DUMUX_FLUX_SHALLOW_WATER_VISCOUS_FLUX_HH
diff --git a/dumux/material/components/h2o.hh b/dumux/material/components/h2o.hh
index 030356e99f..48b176bece 100644
--- a/dumux/material/components/h2o.hh
+++ b/dumux/material/components/h2o.hh
@@ -954,6 +954,7 @@ namespace FluidSystems {
* \brief The dynamic viscosity \f$\mathrm{[Pa*s]}\f$ of steam in a gas mixture.
*
* \param temperature temperature in \f$\mathrm{[K]}\f$
+ * \param pressure pressure
*
* We assume here that water is in mixture with other gaseous components.
* For pure water, use the gasViscosity function of Components::H2O.
@@ -964,7 +965,7 @@ namespace FluidSystems {
* "Reid, R.C., Prausnitz, J.M., Poling, B.E.: The Properties of
* Gases and Liquids (1987)"
* Lucas corresponding states method
- * https://www.osti.gov/scitech/biblio/6504847} \cite{reid1987}
+ * https://www.osti.gov/scitech/biblio/6504847} \cite reid1987
*
* For temperatures above 500 K see:
* Nagel, T. et al.: THC-Processes (2018)
diff --git a/dumux/multidomain/newtonsolver.hh b/dumux/multidomain/newtonsolver.hh
index bfcda6794d..360413d737 100644
--- a/dumux/multidomain/newtonsolver.hh
+++ b/dumux/multidomain/newtonsolver.hh
@@ -104,7 +104,7 @@ public:
* \brief Called before the Newton method is applied to an
* non-linear system of equations.
*
- * \param u The initial solution
+ * \param vars The variables representing the initial solution
*/
void newtonBegin(Variables& vars) override
{
diff --git a/dumux/nonlinear/newtonsolver.hh b/dumux/nonlinear/newtonsolver.hh
index a5705772c6..0b00ce33dc 100644
--- a/dumux/nonlinear/newtonsolver.hh
+++ b/dumux/nonlinear/newtonsolver.hh
@@ -334,6 +334,7 @@ public:
* Does time step control when the Newton fails to converge
* \param vars The variables object representing the current state of the
* numerical solution (primary and possibly secondary variables).
+ * \param timeLoop The time loop.
*/
void solve(Variables& vars, TimeLoop& timeLoop) override
{
diff --git a/dumux/timestepping/multistagetimestepper.hh b/dumux/timestepping/multistagetimestepper.hh
index f9f9757bab..7759ee0113 100644
--- a/dumux/timestepping/multistagetimestepper.hh
+++ b/dumux/timestepping/multistagetimestepper.hh
@@ -122,7 +122,7 @@ public:
/*!
* \brief Advance one time step of the given time loop
- * \params vars The variables object at the current time level.
+ * \param vars The variables object at the current time level.
* \param t The current time level
* \param dt The time step size to be used
* \note We expect the time level in vars to correspond to the given time `t`
--
GitLab