diff --git a/doc/doxygen/Doxylocal b/doc/doxygen/Doxylocal
index 4c084904896d00bca0b7087c92bd344856eca970..9b85a30f9ff521873648e36d2c63da9dbee2a870 100644
--- a/doc/doxygen/Doxylocal
+++ b/doc/doxygen/Doxylocal
@@ -14,8 +14,7 @@ INPUT += @srcdir@/mainpage.txt \
@srcdir@/modules.txt \
@top_srcdir@/dumux \
@top_srcdir@/test \
- # @srcdir@/extradoc/parameterlist.txt \ # we currently do not have a parameter list. Should be back for 3.1
- # @srcdir@/extradoc/featurelist.txt # we currently do not have a feature list. Should be back for 3.1
+ @srcdir@/extradoc/parameterlist.txt
EXAMPLE_PATH += @srcdir@/extradoc
@@ -43,5 +42,8 @@ CITE_BIB_FILES = @top_srcdir@/doc/handbook/dumux-handbook.bib
# enable macro expansion only for specified macros
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
-PREDEFINED += "DUNE_DEPRECATED:=/** \deprecated */" \
- "DUNE_DEPRECATED_MSG(A):=/** \deprecated A */"
+
+DOT_GRAPH_MAX_NODES = 100
+
+# uncomment for the website
+# SHORT_NAMES = NO
diff --git a/doc/doxygen/README.md b/doc/doxygen/README.md
index 11b1a83d1be94a221736c21dec10b5b0a6ab817f..8eaa6f37da31bcfe32ce51486ad54fdba7007f47 100644
--- a/doc/doxygen/README.md
+++ b/doc/doxygen/README.md
@@ -60,3 +60,6 @@ If there are **function-arguments** that are not self-explanatory, they should b
**Always explain all params or no params at all!** Otherwise Doxygen will throw an error.
Template parameters are documented with `\tparam`.
Additional Doxygen-commands that might be useful are `\note` for giving an important note/hint on what the function does as well as `\return` which specifies the return value (if applicable).
+
+April 2020 note: `\copydoc`,`\copybrief` and `\copydetails`, as well as `@copydoc`,`@copybrief` and `@copydetails` do not work with filenames in the current doxygen version.
+The bug is reported and has been fixed in doxygen pull request #7693. (It will work again in doxygen 1_8_18, probably at the end of 2020.)
diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt
index 13cde77a349278477248a6c9eb00428fd98661d9..053abe0624cfb34adc63616af398ae128c2c7f94 100644
--- a/doc/doxygen/modules.txt
+++ b/doc/doxygen/modules.txt
@@ -14,7 +14,7 @@
* \ingroup PorousmediumflowModels
* \defgroup OnePModel 1p
* \brief Single-phase (immiscible) Darcy flow
- * \copydetails ./porousmediumflow/1p/model.hh
+ * For a detailed model decription see porousmediumflow/1p/model.hh
*/
/*!
* \ingroup OnePModel
@@ -31,19 +31,19 @@
* \ingroup PorousmediumflowModels
* \defgroup OnePNCModel 1pnc
* \brief Single-phase, multi-component Darcy flow
- * \copydetails ./porousmediumflow/1pnc/model.hh
+ * For a detailed model decription see porousmediumflow/1pnc/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup OnePNCMinModel 1pncmin
* \brief Single-phase, multi-component Darcy flow with mineralization
- * \copydetails ./porousmediumflow/1pncmin/model.hh
+ * For a detailed model decription see porousmediumflow/1pncmin/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TwoPModel 2p
* \brief Two-phase (immiscible) Darcy flow
- * \copydetails ./porousmediumflow/2p/model.hh
+ * For a detailed model decription see porousmediumflow/2p/model.hh
*/
/*!
* \ingroup TwoPModel
@@ -60,13 +60,13 @@
* \ingroup PorousmediumflowModels
* \defgroup TwoPOneCModel 2p1c
* \brief Two-phase, one-component Darcy flow
- * \copydetails ./porousmediumflow/2p1c/model.hh
+ * For a detailed model decription see porousmediumflow/2p1c/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TwoPTwoCModel 2p2c
* \brief Two-phase, two-component Darcy flow
- * \copydetails ./porousmediumflow/2p2c/model.hh
+ * For a detailed model decription see porousmediumflow/2p2c/model.hh
*/
/*!
* \ingroup TwoPTwoCModel
@@ -83,100 +83,100 @@
* \ingroup PorousmediumflowModels
* \defgroup TwoPNCModel 2pnc
* \brief two-phase, multi-component Darcy flow
- * \copydetails ./porousmediumflow/2pnc/model.hh
+ * For a detailed model decription see porousmediumflow/2pnc/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TwoPNCMinModel 2pncmin
* \brief Two-phase, multi-component Darcy flow with mineralization
- * \copydetails ./porousmediumflow/2pncmin/model.hh
+ * For a detailed model decription see porousmediumflow/2pncmin/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup ThreePModel 3p
* \brief Three-phase (immiscible) Darcy flow
- * \copydetails ./porousmediumflow/3p/model.hh
+ * For a detailed model decription see porousmediumflow/3p/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup ThreePThreeCModel 3p3c
* \brief Three-phase, three-component Darcy flow
- * \copydetails ./porousmediumflow/3p3c/model.hh
+ * For a detailed model decription see porousmediumflow/3p3c/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup ThreePWaterOilModel 3pwateroil
* \brief Three-phase, two-component Darcy flow with water (liquid & gas) and oil
- * \copydetails ./porousmediumflow/3pwateroil/model.hh
+ * For a detailed model decription see porousmediumflow/3pwateroil/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup BoxDFMModel boxdfm
* \brief Vertex-centered, continuous-pressure, conforming lower-dimensional discrete-fracture model
- * \copydetails ./porousmediumflow/boxdfm/model.hh
+ * For a detailed model decription see porousmediumflow/boxdfm/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup CO2Model CO2
* \brief Two-phase, two-component Darcy flow specialized for supercritical CO<sub>2</sub> storage
- * \copydetails ./porousmediumflow/co2/model.hh
+ * For a detailed model decription see porousmediumflow/co2/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup MineralizationModel mineralization
* \brief Model adding components that can precipitate as a solid phase to a standard Darcy flow model
*
- * \copydetails ./porousmediumflow/mineralization/model.hh
+ * For a detailed model decription see porousmediumflow/mineralization/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup MPNCModel mpnc
* \brief Generalized multi-phase, multi-component Darcy flow
*
- * \copydetails ./porousmediumflow/mpnc/model.hh
+ * For a detailed model decription see porousmediumflow/mpnc/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup NonEquilibriumModel NonEquilibrium
* \brief Model that adds nonequilibrium equations to another porous medium flow model (only used in MPNCModel currently)
- * \copydetails ./porousmediumflow/nonequilibrium/model.hh
+ * For a detailed model decription see porousmediumflow/nonequilibrium/model.hh
*/
/*!
* \ingroup NonEquilibriumModel
* \defgroup ThermalNonEquilibriumModel ThermalNonEquilibrium
* \brief Model that adapts the energy localresidual to thermal nonequilibrium
- * \copydetails ./porousmediumflow/nonequilibrium/thermal/localresidual.hh
+ * For a detailed model decription see porousmediumflow/nonequilibrium/thermal/localresidual.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup NIModel nonisothermal
* \brief Model that adds an energy equation (thermal equilibrium) to another porous medium flow model
*
- * \copydetails ./porousmediumflow/nonisothermal/model.hh
+ * For a detailed model decription see porousmediumflow/nonisothermal/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup RichardsModel Richards
* \brief Richards flow
- * \copydetails ./porousmediumflow/richards/model.hh
+ * For a detailed model decription see porousmediumflow/richards/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup RichardsNCModel Richards nc
* \brief Richards multi-component flow
- * \copydetails ./porousmediumflow/richardsnc/model.hh
+ * For a detailed model decription see porousmediumflow/richardsnc/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup SolidEnergyModel Solid energy
* \brief Energy equation for the solid (general heat equation)
- * \copydetails ./porousmediumflow/solidenergy/model.hh
+ * For a detailed model decription see porousmediumflow/solidenergy/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TracerModel Tracer
* \brief Multi-component advection-diffusion-reaction model with given velocity field
- * \copydetails ./porousmediumflow/tracer/model.hh
+ * For a detailed model decription see porousmediumflow/tracer/model.hh
*/
/* ***************** FreeflowModels ******************/
@@ -188,66 +188,66 @@
* \ingroup FreeflowModels
* \defgroup NavierStokesModel Navier-Stokes
* \brief Single-phase Navier-Stokes flow
- * \copydetails ./freeflow/navierstokes/model.hh
+ * For a detailed model decription see freeflow/navierstokes/model.hh
*/
/*!
* \ingroup FreeflowModels
* \defgroup RANSModel Reynolds-Averaged Navier-Stokes
* \brief Single-phase Reynolds-Averaged Navier-Stokes flow
- * \copydetails ./freeflow/rans/model.hh
+ * For a detailed model decription see freeflow/rans/model.hh
*/
/*!
* \ingroup RANSModel
* \defgroup ZeroEqModel 0-Eq. Models
* \brief Zero-equation or algebraic turbulence models
- * \copydetails ./freeflow/rans/zeroeq/model.hh
+ * For a detailed model decription see freeflow/rans/zeroeq/model.hh
*/
/*!
* \ingroup RANSModel
* \defgroup OneEqModel 1-Eq. Models
* \brief One-equation turbulence model by Spalart-Allmaras
- * \copydetails ./freeflow/rans/oneeq/model.hh
+ * For a detailed model decription see freeflow/rans/oneeq/model.hh
*/
/*!
* \ingroup RANSModel
* \defgroup TwoEqModel 2-Eq. Models
* \brief Two-equation turbulence models
*/
- /*!
- * \ingroup TwoEqModel
- * \defgroup KEpsilonModel K-epsilon model
- * \brief K-epsilon model
- * \copydetails ./freeflow/rans/twoeq/kepsilon/model.hh
- */
- /*!
- * \ingroup TwoEqModel
- * \defgroup KOmegaModel K-omega model
- * \brief K-omega model
- * \copydetails ./freeflow/rans/twoeq/komega/model.hh
- */
- /*!
- * \ingroup TwoEqModel
- * \defgroup LowReKEpsilonModel Low-Re k-epsilon model
- * \brief Low-Re k-epsilon model
- * \copydetails ./freeflow/rans/twoeq/lowrekepsilon/model.hh
- */
+ /*!
+ * \ingroup TwoEqModel
+ * \defgroup KEpsilonModel K-epsilon model
+ * \brief K-epsilon model
+ * For a detailed model decription see freeflow/rans/twoeq/kepsilon/model.hh
+ */
+ /*!
+ * \ingroup TwoEqModel
+ * \defgroup KOmegaModel K-omega model
+ * \brief K-omega model
+ * For a detailed model decription see freeflow/rans/twoeq/komega/model.hh
+ */
+ /*!
+ * \ingroup TwoEqModel
+ * \defgroup LowReKEpsilonModel Low-Re k-epsilon model
+ * \brief Low-Re k-epsilon model
+ * For a detailed model decription see freeflow/rans/twoeq/lowrekepsilon/model.hh
+ */
/*!
* \ingroup FreeflowModels
* \defgroup FreeflowNCModel Compositional
* \brief Single-phase multi-component free-flow flow models
- * \copydetails ./freeflow/compositional/navierstokesncmodel.hh
+ * For a detailed model decription see freeflow/compositional/navierstokesncmodel.hh
*/
/*!
* \ingroup FreeflowModels
* \defgroup FreeflowNIModel Nonisothermal
* \brief An energy equation adaptor for isothermal free-flow models
- * \copydetails ./freeflow/nonisothermal/model.hh
+ * For a detailed model decription see freeflow/nonisothermal/model.hh
*/
/*!
* \ingroup FreeflowModels
* \defgroup ShallowWaterModel 2D shallow water model
* \brief Two-dimensional shallow water flow (depth-averaged)
- * \copydetails ./freeflow/shallowwater/model.hh
+ * For a detailed model decription see freeflow/shallowwater/model.hh
*/
/*!
* \defgroup Geomechanics Geomechanics Models
@@ -257,13 +257,13 @@
* \ingroup Geomechanics
* \defgroup Elastic Solid mechanics w/o fluid pressure
* \brief Models linear elastic deformation of a solid. Disregards fluid pressure.
- * \copydetails ./geomechanics/elastic/model.hh
+ * For a detailed model decription see geomechanics/elastic/model.hh
*/
/*!
* \ingroup Geomechanics
* \defgroup PoroElastic Solid mechanics with fluid pressure
* \brief Models linear elastic deformation of a solid. Takes fluid pressure into account.
- * \copydetails ./geomechanics/poroelastic/model.hh
+ * For a detailed model decription see geomechanics/poroelastic/model.hh
*/
/* ***************** Benchmarks and Tests ******************/
@@ -351,6 +351,11 @@
* \defgroup RichardsNCTests Richards multi-component benchmarks and tests
* \brief A multi-component transport problem in the unsaturated zone using the RichardsNCModel. The files are listed below.
*/
+ /*!
+ * \ingroup SolidEnergyTests
+ * \defgroup SolidEnergyTests Solid energy tests
+ * \brief Tests for the solid energy model.
+ */
/*!
* \ingroup PorousmediumflowTests
* \defgroup TracerTests Tracer benchmarks and tests
@@ -464,7 +469,7 @@
*/
/*!
* \ingroup Flux
- * \defgroup BoxFlux Flux related to the Box scheme
+ * \defgroup BoxFlux Flux related to the box scheme
* \brief Flux related to the box scheme
*/
/*!
@@ -654,27 +659,26 @@
* \defgroup AssemblyAndSolvers Assembly and Solvers
* \brief Assembling matrices and vectors, solvers for linear and nonlinear equations
*/
-
-/* ***************** Assembly ******************/
-/*!
- * \ingroup AssemblyAndSolvers
- * \defgroup Assembly Assembly
- * \brief Assembly of linear systems (Jacobian and residual)
- */
-
-/* ***************** Linear ******************/
-/*!
- * \ingroup AssemblyAndSolvers
- * \defgroup Linear Linear
- * \brief Linear solvers and helpers
- */
-
-/* ***************** Nonlinear ******************/
-/*!
- * \ingroup AssemblyAndSolvers
- * \defgroup Nonlinear Nonlinear
- * \brief Nonlinear solvers: Newton method
- */
+ /*!
+ * \ingroup AssemblyAndSolvers
+ * \defgroup Assembly Assembly
+ * \brief Assembly of linear systems (Jacobian and residual)
+ */
+ /*!
+ * \ingroup AssemblyAndSolvers
+ * \defgroup Linear Linear
+ * \brief Linear solvers and helpers
+ */
+ /*!
+ * \ingroup AssemblyAndSolvers
+ * \defgroup Nonlinear Nonlinear
+ * \brief Nonlinear solvers: Newton method
+ */
+ /*!
+ * \ingroup AssemblyAndSolvers
+ * \defgroup Parallel Parallel
+ * \brief Files for communication of parallel solvers
+ */
/* ***************** Common ******************/
/*!
diff --git a/dumux/common/boundaryflag.hh b/dumux/common/boundaryflag.hh
index 49b7770b134ded64641aa2e0efbc2c6b4b516c2c..8429f47ee15decc509d4b01b91659e54cdafc05f 100644
--- a/dumux/common/boundaryflag.hh
+++ b/dumux/common/boundaryflag.hh
@@ -30,7 +30,7 @@
namespace Dumux {
/*!
- * \ingroup InputOutput
+ * \ingroup Common
* \brief Class for accessing boundary flags
* \note this works for all grid managers with gmsh meshes.
*/
diff --git a/dumux/common/doubleexpintegrationconstants.hh b/dumux/common/doubleexpintegrationconstants.hh
index 9c5fdaee4d6795bfe8ffd1b473970bff24fd3969..be4b5f8f582253d8ba416880beacaf50e5296638 100644
--- a/dumux/common/doubleexpintegrationconstants.hh
+++ b/dumux/common/doubleexpintegrationconstants.hh
@@ -48,7 +48,11 @@
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
* *
*****************************************************************************/
-
+/*!
+ * \file
+ * \ingroup Common
+ * \brief Exponential integration abcissas
+ */
#ifndef DUMUX_COMMON_DOUBLEEXP_INTEGRATION_CONSTANTS_HH
#define DUMUX_COMMON_DOUBLEEXP_INTEGRATION_CONSTANTS_HH
diff --git a/dumux/common/doubleexpintegrator.hh b/dumux/common/doubleexpintegrator.hh
index 0b4ba4c848a64bb2be2f243dd8ac7b1b09801d87..3591e82a01e9f538b0a1456af617dbb178489acf 100644
--- a/dumux/common/doubleexpintegrator.hh
+++ b/dumux/common/doubleexpintegrator.hh
@@ -48,7 +48,11 @@
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
* *
*****************************************************************************/
-
+/*!
+ * \file
+ * \ingroup Common
+ * \brief A double exponential integrator
+ */
#ifndef DUMUX_COMMON_DOUBLEEXP_INTEGRATOR_HH
#define DUMUX_COMMON_DOUBLEEXP_INTEGRATOR_HH
diff --git a/dumux/common/staggeredfvproblem.hh b/dumux/common/staggeredfvproblem.hh
index a0ffc55ed33b3950870b9aee6ac15b29c8e21ca1..c74db38cfa03121be5c8a1a4966721fa97ae036b 100644
--- a/dumux/common/staggeredfvproblem.hh
+++ b/dumux/common/staggeredfvproblem.hh
@@ -19,6 +19,7 @@
/*!
* \file
* \ingroup Common
+ * \ingroup StaggeredDiscretization
* \brief Base class for all staggered fv problems
*/
#ifndef DUMUX_STAGGERD_FV_PROBLEM_HH
@@ -33,6 +34,7 @@ namespace Dumux {
/*!
* \ingroup Common
+ * \ingroup StaggeredDiscretization
* \brief Base class for all staggered finite-volume problems
*
* \note All quantities (regarding the units) are specified assuming a
diff --git a/dumux/common/timemanager.hh b/dumux/common/timemanager.hh
index 9e53d104b882c7ddcd1199d947591156572ad36b..6581bfa90fafc5f7a5095c1c317a49cb1ed41825 100644
--- a/dumux/common/timemanager.hh
+++ b/dumux/common/timemanager.hh
@@ -39,7 +39,6 @@ namespace Dumux {
/*!
* \ingroup Common
- * \deprecated
* \brief Manages the handling of time dependent problems.
*
* This class facilitates the time management of the simulation.
diff --git a/dumux/discretization/basegridgeometry.hh b/dumux/discretization/basegridgeometry.hh
index 3e5ac51d5e2dc6209e5586f7525087bf4b7e51f8..5d8c58ff2c89e909a8c6fe306be7682a9a82f3f7 100644
--- a/dumux/discretization/basegridgeometry.hh
+++ b/dumux/discretization/basegridgeometry.hh
@@ -33,7 +33,7 @@
#include <dumux/common/geometry/boundingboxtree.hh>
#include <dumux/common/geometry/geometricentityset.hh>
-//! make the local view function available whenever we use the grid geometry
+// make the local view function available whenever we use the grid geometry
#include <dumux/discretization/localview.hh>
namespace Dumux {
diff --git a/dumux/discretization/box/gridfluxvariablescache.hh b/dumux/discretization/box/gridfluxvariablescache.hh
index 90d6079e80d3872e85af027c327196c87801b6c0..7f884e145bd90972dd4c1956e43365c163ec74f5 100644
--- a/dumux/discretization/box/gridfluxvariablescache.hh
+++ b/dumux/discretization/box/gridfluxvariablescache.hh
@@ -24,7 +24,7 @@
#ifndef DUMUX_DISCRETIZATION_BOX_GRID_FLUXVARSCACHE_HH
#define DUMUX_DISCRETIZATION_BOX_GRID_FLUXVARSCACHE_HH
-//! make the local view function available whenever we use this class
+// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/box/elementfluxvariablescache.hh>
diff --git a/dumux/discretization/box/gridvolumevariables.hh b/dumux/discretization/box/gridvolumevariables.hh
index 9a54ece6e444b0860ea0e8c34f15d52f82d45225..7fb514100bdfb48f8c0e3732b02e2001f25350fb 100644
--- a/dumux/discretization/box/gridvolumevariables.hh
+++ b/dumux/discretization/box/gridvolumevariables.hh
@@ -26,7 +26,7 @@
#include <type_traits>
-//! make the local view function available whenever we use this class
+// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/box/elementvolumevariables.hh>
#include <dumux/discretization/box/elementsolution.hh>
diff --git a/dumux/discretization/cellcentered/gridvolumevariables.hh b/dumux/discretization/cellcentered/gridvolumevariables.hh
index 62897f109bf41e51ff3fb1d099ad3d47e6ea3906..fddd114a4ebeb0520aa8bdf197c74ce90d297c13 100644
--- a/dumux/discretization/cellcentered/gridvolumevariables.hh
+++ b/dumux/discretization/cellcentered/gridvolumevariables.hh
@@ -27,7 +27,7 @@
#include <vector>
#include <type_traits>
-//! make the local view function available whenever we use this class
+// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/cellcentered/elementsolution.hh>
diff --git a/dumux/discretization/cellcentered/mpfa/gridfluxvariablescache.hh b/dumux/discretization/cellcentered/mpfa/gridfluxvariablescache.hh
index 0b1a77744d09b6834dc448e8c312801022f691a3..3bfc795c63249e8d39c8fef2f0723c251d8772bd 100644
--- a/dumux/discretization/cellcentered/mpfa/gridfluxvariablescache.hh
+++ b/dumux/discretization/cellcentered/mpfa/gridfluxvariablescache.hh
@@ -24,7 +24,7 @@
#ifndef DUMUX_DISCRETIZATION_CCMPFA_GRID_FLUXVARSCACHE_HH
#define DUMUX_DISCRETIZATION_CCMPFA_GRID_FLUXVARSCACHE_HH
-//! make the local view function available whenever we use this class
+// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/cellcentered/mpfa/elementfluxvariablescache.hh>
diff --git a/dumux/discretization/cellcentered/mpfa/helper.hh b/dumux/discretization/cellcentered/mpfa/helper.hh
index e44bff5a2924aeccf604eee980f485a94c44e433..bf043565716cee80d5e0aadd62eadadff9aa38b4 100644
--- a/dumux/discretization/cellcentered/mpfa/helper.hh
+++ b/dumux/discretization/cellcentered/mpfa/helper.hh
@@ -196,7 +196,7 @@ public:
/*!
* \ingroup CCMpfaDiscretization
- * \brief Dimension-specific mpfa helper class for dim == 2 & dimWorld == 2.
+ * \brief Dimension-specific mpfa helper class for dim == 2 & dimWorld == 3.
* Reuses some functionality of the specialization for dim = dimWorld = 2
*/
template<class GridGeometry>
diff --git a/dumux/discretization/cellcentered/mpfa/localassemblerbase.hh b/dumux/discretization/cellcentered/mpfa/localassemblerbase.hh
index d1f76822045bee375b184231750d97a46361392e..20558faa90328816693c8dd37a0e77dd58d4de22 100644
--- a/dumux/discretization/cellcentered/mpfa/localassemblerbase.hh
+++ b/dumux/discretization/cellcentered/mpfa/localassemblerbase.hh
@@ -90,6 +90,7 @@ class InteractionVolumeAssemblerBase
* expressions and the local system of equations
* within an mpfa interaction volume.
*
+ * \tparam DataHandle The data handle
* \tparam IV The interaction volume type implementation
* \tparam TensorFunc Lambda to obtain the tensor w.r.t.
* which the local system is to be solved
@@ -97,6 +98,7 @@ class InteractionVolumeAssemblerBase
* \param handle The data handle in which the matrices are stored
* \param iv The interaction volume
* \param getT Lambda to evaluate the scv-wise tensors
+ * \param wijZeroThresh the zero threshold wij
*/
template< class DataHandle, class IV, class TensorFunc >
void assembleMatrices(DataHandle& handle, IV& iv, const TensorFunc& getT, Scalar<IV> wijZeroThresh = 0.0)
diff --git a/dumux/discretization/cellcentered/tpfa/gridfluxvariablescache.hh b/dumux/discretization/cellcentered/tpfa/gridfluxvariablescache.hh
index f368da20db8e14d537a5cb731c8addeb2e4b9a81..f40853ed125c580054ef6610a1e71519e6105c50 100644
--- a/dumux/discretization/cellcentered/tpfa/gridfluxvariablescache.hh
+++ b/dumux/discretization/cellcentered/tpfa/gridfluxvariablescache.hh
@@ -24,7 +24,7 @@
#ifndef DUMUX_DISCRETIZATION_CCTPFA_GRID_FLUXVARSCACHE_HH
#define DUMUX_DISCRETIZATION_CCTPFA_GRID_FLUXVARSCACHE_HH
-//! make the local view function available whenever we use this class
+// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/cellcentered/tpfa/elementfluxvariablescache.hh>
diff --git a/dumux/discretization/staggered/freeflow/gridvolumevariables.hh b/dumux/discretization/staggered/freeflow/gridvolumevariables.hh
index badedcf28729620dffd1ae17fe2df2e7ff883aa7..85534fa69c674a85b532a55def31d30756a0031b 100644
--- a/dumux/discretization/staggered/freeflow/gridvolumevariables.hh
+++ b/dumux/discretization/staggered/freeflow/gridvolumevariables.hh
@@ -27,7 +27,7 @@
#include <dune/common/exceptions.hh>
#include <dune/common/rangeutilities.hh>
-//! make the local view function available whenever we use this class
+// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/staggered/elementsolution.hh>
#include <dumux/discretization/staggered/freeflow/elementvolumevariables.hh>
diff --git a/dumux/discretization/staggered/gridfacevariables.hh b/dumux/discretization/staggered/gridfacevariables.hh
index ccc8859b48176b79a1e84de90a0547fec5257763..f968199a1ca9464790314ad0f5280308f252e712 100644
--- a/dumux/discretization/staggered/gridfacevariables.hh
+++ b/dumux/discretization/staggered/gridfacevariables.hh
@@ -24,7 +24,7 @@
#ifndef DUMUX_DISCRETIZATION_STAGGERED_GRID_FACEVARIABLES_HH
#define DUMUX_DISCRETIZATION_STAGGERED_GRID_FACEVARIABLES_HH
-//! make the local view function available whenever we use this class
+// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/staggered/elementfacevariables.hh>
#include <dumux/discretization/staggered/facesolution.hh>
diff --git a/dumux/discretization/staggered/gridfluxvariablescache.hh b/dumux/discretization/staggered/gridfluxvariablescache.hh
index b78cbe750302a58f66f18bc8dc4d04d6afeff516..ccef6e2e20871613b82296fef0e2882a1e3cf00b 100644
--- a/dumux/discretization/staggered/gridfluxvariablescache.hh
+++ b/dumux/discretization/staggered/gridfluxvariablescache.hh
@@ -24,7 +24,7 @@
#ifndef DUMUX_DISCRETIZATION_STAGGERED_GRID_FLUXVARSCACHE_HH
#define DUMUX_DISCRETIZATION_STAGGERED_GRID_FLUXVARSCACHE_HH
-//! make the local view function available whenever we use this class
+// make the local view function available whenever we use this class
#include <dumux/discretization/localview.hh>
#include <dumux/discretization/staggered/elementfluxvariablescache.hh>
diff --git a/dumux/flux/box/fourierslawnonequilibrium.hh b/dumux/flux/box/fourierslawnonequilibrium.hh
index ce617390579306eebd7eea05d0ecd9f840ecdd09..8add74d1306948685fbff064b5c7f2c98fcca85e 100644
--- a/dumux/flux/box/fourierslawnonequilibrium.hh
+++ b/dumux/flux/box/fourierslawnonequilibrium.hh
@@ -41,7 +41,7 @@ template <class TypeTag, DiscretizationMethod discMethod>
class FouriersLawNonEquilibriumImplementation;
/*!
- * \ingroup BoxFouriersLaw
+ * \ingroup BoxFlux
* \brief Specialization of Fourier's Law for the box method for thermal nonequilibrium models.
*/
template <class TypeTag>
diff --git a/dumux/flux/fluxvariablescaching.hh b/dumux/flux/fluxvariablescaching.hh
index 680b3ce2ab572c556a7d4561c22160ff72ef6714..1c63433b154b336cfc02fbc88079e3b2c5c63333 100644
--- a/dumux/flux/fluxvariablescaching.hh
+++ b/dumux/flux/fluxvariablescaching.hh
@@ -57,7 +57,7 @@ struct _EmptyCache
#endif // DOXYGEN
/*!
- * \ingroup Discretization
+ * \ingroup Flux
* \brief Empty caches to use in a constitutive flux law/process, e.g. Darcy's law
*/
struct EmptyAdvectionCache : public _EmptyCache {};
diff --git a/dumux/freeflow/compositional/kepsilonncmodel.hh b/dumux/freeflow/compositional/kepsilonncmodel.hh
index f0f4b971fa9da6a5a8756f7a51892458eb003791..b66f570c888c4df2fda36b12df689aedf02f1ac6 100644
--- a/dumux/freeflow/compositional/kepsilonncmodel.hh
+++ b/dumux/freeflow/compositional/kepsilonncmodel.hh
@@ -22,7 +22,7 @@
*
* \brief A single-phase, multi-component k-epsilon model
*
- * \copydoc dumux/freeflow/compositional/navierstokesncmodel.hh
+ * For a detailed model decription see dumux/freeflow/compositional/navierstokesncmodel.hh
*/
#ifndef DUMUX_KEPSILON_NC_MODEL_HH
diff --git a/dumux/freeflow/compositional/komegancmodel.hh b/dumux/freeflow/compositional/komegancmodel.hh
index 1a4c22f8fd841c4f8bc115a6aa3cfa15c1026739..0aa09c71ae97ef479166d7a480c2f5065c3b2472 100644
--- a/dumux/freeflow/compositional/komegancmodel.hh
+++ b/dumux/freeflow/compositional/komegancmodel.hh
@@ -22,7 +22,7 @@
*
* \brief A single-phase, multi-component k-omega model
*
- * \copydoc dumux/freeflow/compositional/navierstokesncmodel.hh
+ * For a detailed model decription see dumux/freeflow/compositional/navierstokesncmodel.hh
*/
#ifndef DUMUX_KOMEGA_NC_MODEL_HH
diff --git a/dumux/freeflow/compositional/lowrekepsilonncmodel.hh b/dumux/freeflow/compositional/lowrekepsilonncmodel.hh
index 3b5059b804f4ca24b4446ee3f59b7d720e204d8f..1c78eb69a8bed995b82097784a827d5b31efcc31 100644
--- a/dumux/freeflow/compositional/lowrekepsilonncmodel.hh
+++ b/dumux/freeflow/compositional/lowrekepsilonncmodel.hh
@@ -22,7 +22,7 @@
*
* \brief A single-phase, multi-component low-Re k-epsilon model
*
- * \copydoc dumux/freeflow/compositional/navierstokesncmodel.hh
+ * For a detailed model decription see dumux/freeflow/compositional/navierstokesncmodel.hh
*/
#ifndef DUMUX_LOWREKEPSILON_NC_MODEL_HH
diff --git a/dumux/freeflow/compositional/navierstokesncmodel.hh b/dumux/freeflow/compositional/navierstokesncmodel.hh
index 8879363a582becce135d54d7f38d345faced67de..63a26feb04ed2fd87132fd8269988008c393cf50 100644
--- a/dumux/freeflow/compositional/navierstokesncmodel.hh
+++ b/dumux/freeflow/compositional/navierstokesncmodel.hh
@@ -20,9 +20,11 @@
* \file
* \ingroup FreeflowNCModel
*
- * \copydoc dumux/freeflow/navierstokes/model.hh
+ * \brief A single-phase, multi-component free-flow model
*
- * The system is closed by a <B> component mass/mole balance equation </B> for each component \f$\kappa\f$:
+ * For an equations not specific to multiple components see dumux/freeflow/navierstokes/model.hh
+ *
+ * The multi-component system is closed by a <B> component mass/mole balance equation </B> for each component \f$\kappa\f$:
* \f[
* \frac{\partial \left(\varrho X^\kappa\right)}{\partial t}
* + \nabla \cdot \left( \varrho {\boldsymbol{v}} X^\kappa
diff --git a/dumux/freeflow/compositional/oneeqncmodel.hh b/dumux/freeflow/compositional/oneeqncmodel.hh
index 411124141a542aff9ffa4b88728375f33fa7e49a..01a96fcb406b2172c7010fe4da674bb803f343e8 100644
--- a/dumux/freeflow/compositional/oneeqncmodel.hh
+++ b/dumux/freeflow/compositional/oneeqncmodel.hh
@@ -22,7 +22,7 @@
*
* \brief A single-phase, multi-component one-equation model
*
- * \copydoc dumux/freeflow/compositional/navierstokesncmodel.hh
+ * For a detailed model decription see dumux/freeflow/compositional/navierstokesncmodel.hh
*/
#ifndef DUMUX_ONEEQ_NC_MODEL_HH
diff --git a/dumux/freeflow/compositional/zeroeqncmodel.hh b/dumux/freeflow/compositional/zeroeqncmodel.hh
index 498f00ec596c1d7aeb51b987ba4c13fdc7158f7f..8d0ee38b41fc7d0f30860f72e81a38095c07490b 100644
--- a/dumux/freeflow/compositional/zeroeqncmodel.hh
+++ b/dumux/freeflow/compositional/zeroeqncmodel.hh
@@ -22,7 +22,7 @@
*
* \brief A single-phase, multi-component Reynolds-Averaged Navier-Stokes 0-Eq. model
*
- * \copydoc dumux/freeflow/compositional/navierstokesncmodel.hh
+ * For a detailed model decription see dumux/freeflow/compositional/navierstokesncmodel.hh
*/
#ifndef DUMUX_ZEROEQ_NC_MODEL_HH
@@ -57,6 +57,7 @@ struct ZeroEqNC { using InheritsFrom = std::tuple<NavierStokesNC>; };
///////////////////////////////////////////////////////////////////////////
/*!
+ * \ingroup FreeflowNCModel
* \ingroup ZeroEqModel
* \brief Traits for the Reynolds-averaged Navier-Stokes 0-Eq. model
*/
diff --git a/dumux/freeflow/rans/twoeq/indices.hh b/dumux/freeflow/rans/twoeq/indices.hh
index 3ce7ab167f04909bd52690eb7aee4f1c8d4be838..484830c58c351e8e23b9feca44e542a480f08fc6 100644
--- a/dumux/freeflow/rans/twoeq/indices.hh
+++ b/dumux/freeflow/rans/twoeq/indices.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup RANSModel
+ * \ingroup TwoEqModel
* \copydoc Dumux::RANSTwoEqIndices
*/
#ifndef DUMUX_RANS_TWO_EQ_INDICES_HH
@@ -30,7 +30,7 @@ namespace Dumux {
// \{
/*!
- * \ingroup RANSModel
+ * \ingroup TwoEqModel
* \brief The common indices for isothermal two-equation RANS models.
*
* \tparam dimension The dimension of the problem
diff --git a/dumux/freeflow/staggeredupwindmethods.hh b/dumux/freeflow/staggeredupwindmethods.hh
index 28ff9e223ff24cef88463f2af2fe12f29e4532ac..bc1d6065683de804d2a5c7039726efcb8f69304c 100644
--- a/dumux/freeflow/staggeredupwindmethods.hh
+++ b/dumux/freeflow/staggeredupwindmethods.hh
@@ -16,9 +16,11 @@
* You should have received a copy of the GNU General Public License *
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
-/** \file
- * \brief This file contains different higher order methods for approximating the velocity.
- */
+/*!
+ * \file
+ * \ingroup FreeflowModels
+ * \brief This file contains different higher order methods for approximating the velocity.
+ */
#ifndef DUMUX_UPWINDING_METHODS_HH
#define DUMUX_UPWINDING_METHODS_HH
@@ -33,21 +35,28 @@
namespace Dumux {
-//! \brief Available Tvd approaches
+/*!
+ * \ingroup FreeflowModels
+ * \brief Available Tvd approaches
+ */
enum class TvdApproach
{
none, uniform, li, hou
};
-//! \brief Available differencing schemes
+/*!
+ * \ingroup FreeflowModels
+ * \brief Available differencing schemes
+ */
enum class DifferencingScheme
{
none, vanleer, vanalbada, minmod, superbee, umist, mclimiter, wahyd
};
-/**
- * \brief This file contains different higher order methods for approximating the velocity.
- */
+/*!
+ * \ingroup FreeflowModels
+ * \brief This file contains different higher order methods for approximating the velocity.
+ */
template<class Scalar, int upwindSchemeOrder>
class StaggeredUpwindMethods
{
diff --git a/dumux/geomechanics/elastic/indices.hh b/dumux/geomechanics/elastic/indices.hh
index be7411a149767ca7e35f7dd91edfb00625226644..892b21d155314d62e7228a3e37ccdce57e3fc46d 100644
--- a/dumux/geomechanics/elastic/indices.hh
+++ b/dumux/geomechanics/elastic/indices.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief Defines the indices for the elastic model
*/
#ifndef DUMUX_ELASTIC_INDICES_HH
@@ -27,7 +27,7 @@
namespace Dumux {
/*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief The indices for the linear elasticity model.
*/
struct ElasticIndices
diff --git a/dumux/geomechanics/elastic/localresidual.hh b/dumux/geomechanics/elastic/localresidual.hh
index 0c1a3eb6af6e639449b7e1cbb5e76c079449fabe..cf4bc3972c810ac88bb682d6b34aae1dfce835aa 100644
--- a/dumux/geomechanics/elastic/localresidual.hh
+++ b/dumux/geomechanics/elastic/localresidual.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief Element-wise calculation of the local residual for problems
* using the elastic model considering linear elasticity.
*/
@@ -32,7 +32,7 @@
namespace Dumux {
/*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief Element-wise calculation of the local residual for problems
* using the elastic model considering linear elasticity.
*/
diff --git a/dumux/geomechanics/elastic/model.hh b/dumux/geomechanics/elastic/model.hh
index 05c041dbf9a42a9f6714a05609a83b65382b99b3..82614c943f8ff39a015ecf7e49dd6a2987a83f91 100644
--- a/dumux/geomechanics/elastic/model.hh
+++ b/dumux/geomechanics/elastic/model.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief Defines a type tag and some properties for the elastic geomechanical model
*/
#ifndef DUMUX_GEOMECHANICS_ELASTIC_MODEL_HH
@@ -39,7 +39,7 @@
namespace Dumux {
/*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief Specifies a number properties of the elastic model
*/
template< int dim, int numSolidComp >
@@ -61,7 +61,7 @@ struct ElasticModelTraits
};
/*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief Traits class for the volume variables of the elastic model.
*
* \tparam PV The type used for primary variables
diff --git a/dumux/geomechanics/elastic/volumevariables.hh b/dumux/geomechanics/elastic/volumevariables.hh
index fe8836e17a42e2b42c25d706f8cea8634671f13e..add72433a16da2ec191bb871753ee349e28bee76 100644
--- a/dumux/geomechanics/elastic/volumevariables.hh
+++ b/dumux/geomechanics/elastic/volumevariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief Quantities required by the elastic model defined on a sub-control volume.
*/
#ifndef DUMUX_ELASTIC_VOLUME_VARIABLES_HH
@@ -33,7 +33,7 @@
namespace Dumux {
/*!
- * \ingroup Geomechanics
+ * \ingroup Elastic
* \brief Contains the quantities which are constant within a
* finite volume in the elastic model.
*
diff --git a/dumux/geomechanics/poroelastic/couplingmanager.hh b/dumux/geomechanics/poroelastic/couplingmanager.hh
index 498477afc2f7c633e76fcd98158e35ef85b681d4..a49e3e79e4d48cbaac9f8c4bf0aa9af72f30bdb3 100644
--- a/dumux/geomechanics/poroelastic/couplingmanager.hh
+++ b/dumux/geomechanics/poroelastic/couplingmanager.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical problem
*/
@@ -37,7 +37,7 @@ namespace Dumux {
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Coupling manager for porous medium flow problems coupled to a poro-mechanical problem
*
* Coupling manager for porous medium flow problems coupled to a poro-mechanical
diff --git a/dumux/geomechanics/poroelastic/iofields.hh b/dumux/geomechanics/poroelastic/iofields.hh
index 3127c3a21f0f2c9fa40754cfd240673d41be2a3f..3d053899563f249b67f386d61c371fbe495a535e 100644
--- a/dumux/geomechanics/poroelastic/iofields.hh
+++ b/dumux/geomechanics/poroelastic/iofields.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Adds I/O fields specific to the poro-elastic model
*/
#ifndef DUMUX_POROELASTIC_IO_FIELDS_HH
@@ -29,7 +29,7 @@
namespace Dumux {
/*!
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Adds I/O fields specific to the poro-elastic model
*/
class PoroElasticIOFields
diff --git a/dumux/geomechanics/poroelastic/localresidual.hh b/dumux/geomechanics/poroelastic/localresidual.hh
index 26f8f0c53a330a32927f5ef47ff2521764eff70f..9ee1188a70d8135bec27d4a4076d879c6e4071ef 100644
--- a/dumux/geomechanics/poroelastic/localresidual.hh
+++ b/dumux/geomechanics/poroelastic/localresidual.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Element-wise calculation of the local residual
* for problems using the poroelastic model.
*/
@@ -31,7 +31,7 @@
namespace Dumux {
/*!
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Element-wise calculation of the local residual
* for problems using the poroelastic model.
*/
diff --git a/dumux/geomechanics/poroelastic/model.hh b/dumux/geomechanics/poroelastic/model.hh
index cea6945b1254d77fcc8b388b8137305be3a63896..68334dd6e781e40eababcfa2ef37bc3483dec67d 100644
--- a/dumux/geomechanics/poroelastic/model.hh
+++ b/dumux/geomechanics/poroelastic/model.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Defines a type tag and some properties for the poroelastic geomechanical model
*/
#ifndef DUMUX_GEOMECHANICS_POROELASTIC_MODEL_HH
@@ -40,7 +40,7 @@
namespace Dumux {
/*!
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Specifies a number properties of the poroelastic model
*/
template< int dim, int numSC, int numFP, int numFC >
diff --git a/dumux/geomechanics/poroelastic/volumevariables.hh b/dumux/geomechanics/poroelastic/volumevariables.hh
index 3b94dd5ac7a560fbc33d523a1b6a21e3eae7565b..682e7fbf8b818a196679b84ec3be9a41293101f8 100644
--- a/dumux/geomechanics/poroelastic/volumevariables.hh
+++ b/dumux/geomechanics/poroelastic/volumevariables.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Quantities required by the poroelastic model defined on a sub-control volume.
*/
#ifndef DUMUX_POROELASTIC_VOLUME_VARIABLES_HH
@@ -29,7 +29,7 @@
namespace Dumux {
/*!
- * \ingroup Geomechanics
+ * \ingroup PoroElastic
* \brief Contains the quantities which are constant within a
* finite volume in the poroelastic model.
*
diff --git a/dumux/io/grid/gridmanager_alu.hh b/dumux/io/grid/gridmanager_alu.hh
index cdf03c364e8babfa3cc909eda3e523b3bd5b1480..1a6906d9ac1f8c2763e29873aa3ab889a43ce77f 100644
--- a/dumux/io/grid/gridmanager_alu.hh
+++ b/dumux/io/grid/gridmanager_alu.hh
@@ -43,6 +43,7 @@ namespace Dumux {
#if HAVE_DUNE_ALUGRID
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for Dune ALUGrids
* from information in the input file
*
@@ -231,6 +232,10 @@ public:
}
};
+/*!
+ * \ingroup InputOutput
+ * \brief Boundary flag
+ */
//! alu uses boundary id
template<int dim, int dimworld, Dune::ALUGridElementType elType, Dune::ALUGridRefinementType refinementType>
class BoundaryFlag<Dune::ALUGrid<dim, dimworld, elType, refinementType>>
diff --git a/dumux/io/grid/gridmanager_base.hh b/dumux/io/grid/gridmanager_base.hh
index c3ee66b62f2a20bed099e1b00f00b2453e126328..78f56e1c99a0eb2ff5ef058f2d2904d125d2624b 100644
--- a/dumux/io/grid/gridmanager_base.hh
+++ b/dumux/io/grid/gridmanager_base.hh
@@ -55,6 +55,7 @@
namespace Dumux {
/*!
+ * \ingroup InputOutput
* \brief The grid manager (this is the class used by the user) for all supported grid managers that constructs a grid
* from information in the input file and handles the data.
* \note This class is specialised below for all supported grid managers. It inherits the functionality of the base class Dumux::GridManagerBase.
diff --git a/dumux/io/grid/gridmanager_foam.hh b/dumux/io/grid/gridmanager_foam.hh
index b591c5be6c2f7ea6fd0076aa6abdbe9ca8e2e33c..8ca5a5633231cabb51701e5bf9532c98bc764da3 100644
--- a/dumux/io/grid/gridmanager_foam.hh
+++ b/dumux/io/grid/gridmanager_foam.hh
@@ -39,6 +39,7 @@ namespace Dumux {
#if HAVE_DUNE_FOAMGRID
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for FoamGrids
* from information in the input file
*
@@ -95,6 +96,7 @@ public:
};
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for FoamGrids of dim 1
* from information in the input file
*
diff --git a/dumux/io/grid/gridmanager_mmesh.hh b/dumux/io/grid/gridmanager_mmesh.hh
index 2ef9d76547edd6daa856089e2aee3af672b3dd0b..fc69fcbe5912d1ae9799d9474249618fa24f4d3a 100644
--- a/dumux/io/grid/gridmanager_mmesh.hh
+++ b/dumux/io/grid/gridmanager_mmesh.hh
@@ -37,6 +37,7 @@ namespace Dumux {
#if HAVE_DUNE_MMESH
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for Dune MMesh
* from information in the input file
*
diff --git a/dumux/io/grid/gridmanager_oned.hh b/dumux/io/grid/gridmanager_oned.hh
index 0ae0026e9bc211a7958a768bd3362a446d0c603f..75cbdba920b9f55e430b5e9bfc7ff2b99f30cccf 100644
--- a/dumux/io/grid/gridmanager_oned.hh
+++ b/dumux/io/grid/gridmanager_oned.hh
@@ -34,6 +34,7 @@
namespace Dumux {
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for OneDGrids
* from information in the input file
*
diff --git a/dumux/io/grid/gridmanager_sp.hh b/dumux/io/grid/gridmanager_sp.hh
index 95b132053cd36468c8e457b8914abd9997cbfe51..645f306b48e3e4590f5e4d27ccd0d80f8557b6a9 100644
--- a/dumux/io/grid/gridmanager_sp.hh
+++ b/dumux/io/grid/gridmanager_sp.hh
@@ -39,6 +39,7 @@ namespace Dumux {
#if HAVE_DUNE_SPGRID
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for SPGrid
*
* The following keys are recognized:
diff --git a/dumux/io/grid/gridmanager_ug.hh b/dumux/io/grid/gridmanager_ug.hh
index 6ede5af6bf05b813a71eea33d7064668505ba087..a112d97c533eab8442367d52830858f6e35296f2 100644
--- a/dumux/io/grid/gridmanager_ug.hh
+++ b/dumux/io/grid/gridmanager_ug.hh
@@ -38,6 +38,7 @@ namespace Dumux {
#if HAVE_UG
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for UGGrids
* from information in the input file
*
diff --git a/dumux/io/grid/gridmanager_yasp.hh b/dumux/io/grid/gridmanager_yasp.hh
index 2f5d6aae94b56085065b8ba8a10205186297809c..5ffbbbc4b3f3cb941c328552b3cbd8ff564ca9b8 100644
--- a/dumux/io/grid/gridmanager_yasp.hh
+++ b/dumux/io/grid/gridmanager_yasp.hh
@@ -34,6 +34,7 @@
namespace Dumux {
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for YaspGrids
* from information in the input file
*
@@ -173,6 +174,7 @@ private:
};
/*!
+ * \ingroup InputOutput
* \brief Provides a grid manager for YaspGrids with different zones and grading
*
* All keys are expected to be in group GridParameterGroup.
diff --git a/dumux/material/components/ammonia.hh b/dumux/material/components/ammonia.hh
index 22ab1ea141ebd6fe74e4bd10be8ca83071a6a33d..4f30f7a1659c7667a685dc532aeb404b7d022b81 100644
--- a/dumux/material/components/ammonia.hh
+++ b/dumux/material/components/ammonia.hh
@@ -29,6 +29,10 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief A class for the Ammonia (NH3) component properties
+ */
template <class Scalar>
class Ammonia
: public Components::Base<Scalar, Ammonia<Scalar> >
diff --git a/dumux/material/components/base.hh b/dumux/material/components/base.hh
index 23e84bac9c8c73d866731c39001dbb65f446fe0b..14aa6e29a3aef9c6c5e3c5e607577338f782cfb4 100644
--- a/dumux/material/components/base.hh
+++ b/dumux/material/components/base.hh
@@ -39,9 +39,21 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief IsAqueous struct
+ */
template <class Component>
struct IsAqueous : public std::false_type {};
+/*!
+ * \ingroup Components
+ * \brief Base class for all components
+ * Components provide the thermodynamic relations for the liquid,
+ * gaseous and/or solid state of a single
+ * chemical species or a _fixed_ mixture of species.
+ * Fluid systems use components to compute thermodynamic quantities of phases.
+ */
template <class ScalarType, class Component>
class Base
{
diff --git a/dumux/material/components/chlorideion.hh b/dumux/material/components/chlorideion.hh
index 57ffb73fd71cb3657ecb541b67253b4b4e27bb2b..f4981b4f76d69e2c7e1cac2e4a676209eea318e0 100644
--- a/dumux/material/components/chlorideion.hh
+++ b/dumux/material/components/chlorideion.hh
@@ -30,6 +30,10 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief A class for the Cl- (Chloride ion) component properties
+ */
template <class Scalar>
class ChlorideIon
: public Components::Base<Scalar, ChlorideIon<Scalar> >
diff --git a/dumux/material/components/componenttraits.hh b/dumux/material/components/componenttraits.hh
index dc6563fdcb18b51bd148c6b6ab8d62d94af8739e..70d515725f2338bac11dd3461557210cbc096136 100644
--- a/dumux/material/components/componenttraits.hh
+++ b/dumux/material/components/componenttraits.hh
@@ -34,6 +34,10 @@
namespace Dumux {
+/*!
+ * \ingroup Components
+ * \brief Component traits, i.e. information extracted from components
+ */
template<class Component>
struct ComponentTraits
{
diff --git a/dumux/material/components/glucose.hh b/dumux/material/components/glucose.hh
index 4db90784ab7add77daa98ff2e1e218e612b997b1..17e304537eb894d84ac538b591f7a9944cfbae03 100644
--- a/dumux/material/components/glucose.hh
+++ b/dumux/material/components/glucose.hh
@@ -30,6 +30,10 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief A class for the Glucose component properties
+ */
template <class Scalar>
class Glucose
: public Components::Base<Scalar, Glucose<Scalar> >
diff --git a/dumux/material/components/n2.hh b/dumux/material/components/n2.hh
index e4f248b40dd73f41ded6cceb4a46bbba6d2903e9..accec3a4dcde9733c41c70f12687d058340b0164 100644
--- a/dumux/material/components/n2.hh
+++ b/dumux/material/components/n2.hh
@@ -35,7 +35,7 @@ namespace Dumux {
namespace Components {
/*!
- * \ingroup Componentss
+ * \ingroup Components
* \brief Properties of pure molecular nitrogen \f$N_2\f$.
*
* \tparam Scalar The type used for scalar values
diff --git a/dumux/material/components/sodiumion.hh b/dumux/material/components/sodiumion.hh
index 4304df72038c97441cd89e9b8a6671b13beabb42..c5889924935ca39330fce2ff2a345bbf489b94d7 100644
--- a/dumux/material/components/sodiumion.hh
+++ b/dumux/material/components/sodiumion.hh
@@ -30,7 +30,10 @@
namespace Dumux {
namespace Components {
-
+/*!
+ * \ingroup Components
+ * \brief A class for the Na+ (Sodium ion) component properties
+ */
template <class Scalar>
class SodiumIon
: public Components::Base<Scalar, SodiumIon<Scalar> >
diff --git a/dumux/material/components/solid.hh b/dumux/material/components/solid.hh
index 0581330f6b4faffe54ebad34aa32aac316942d78..4030fed68ace9c70e9f0a485c8923cd3c06da31b 100644
--- a/dumux/material/components/solid.hh
+++ b/dumux/material/components/solid.hh
@@ -32,6 +32,10 @@
namespace Dumux {
namespace Components {
+/*!
+ * \ingroup Components
+ * \brief Interface for components that have a solid state
+ */
template<class Scalar, class Component>
class Solid
{
diff --git a/dumux/material/components/urea.hh b/dumux/material/components/urea.hh
index 37d0787299fb1c78f2b49825e7cabd0b58f6011e..5f27451a383574c001578b6dba5b49acf01c9cb1 100644
--- a/dumux/material/components/urea.hh
+++ b/dumux/material/components/urea.hh
@@ -30,6 +30,9 @@
namespace Dumux {
namespace Components {
+/*! \ingroup Components
+ * \brief A class for the Urea component properties
+ */
template <class Scalar>
class Urea
: public Components::Base<Scalar, Urea<Scalar> >
diff --git a/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh b/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
index 774ac531c980237fa972aa321fd24e53b81b35b8..292bee588b5a91dfab6d7bc55739aaa9c1b788c0 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivityconstanttortuosity.hh
@@ -69,7 +69,8 @@ public:
* on a constant tortuosity value
* \param volVars The Volume Variables
* \param phaseIdx the index of the phase
- * \param compIdx the component index
+ * \param compIdxI the component index i
+ * \param compIdxJ the component index j
*/
template<class VolumeVariables>
static Scalar effectiveDiffusionCoefficient(const VolumeVariables& volVars,
diff --git a/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh b/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
index 806d9fafbcaee18bab52ef49dccd8f5a526595aa..3255db535356fa527f2765fa5195005fa96276d0 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
@@ -75,7 +75,8 @@ public:
*
* \param volVars The Volume Variables
* \param phaseIdx the index of the phase
- * \param compIdx the component index
+ * \param compIdxI the component index i
+ * \param compIdxJ the component index j
*/
template<class VolumeVariables>
static Scalar effectiveDiffusionCoefficient(const VolumeVariables& volVars,
diff --git a/dumux/multidomain/facet/codimonegridadapter.hh b/dumux/multidomain/facet/codimonegridadapter.hh
index fceeec3bc7f7a65889bc352700784eeeec283ea6..98be2a3be5e83cfef830f68b157244cae60dbd95 100644
--- a/dumux/multidomain/facet/codimonegridadapter.hh
+++ b/dumux/multidomain/facet/codimonegridadapter.hh
@@ -20,7 +20,7 @@
/*!
* \file
* \ingroup FacetCoupling
- * \brief copydoc Dumux::CodimOneGridAdapter
+ * \copydoc Dumux::CodimOneGridAdapter
*/
#ifndef DUMUX_FACETCOUPLING_CODIM_ONE_GRID_ADAPTER_HH
#define DUMUX_FACETCOUPLING_CODIM_ONE_GRID_ADAPTER_HH
diff --git a/dumux/multidomain/facet/enrichmenthelper.hh b/dumux/multidomain/facet/enrichmenthelper.hh
index 1e93d97016980e4c5b9e87951af79085cb7f0b9c..17fefcf892da3208578ca1c5eb3ba7544d8465cc 100644
--- a/dumux/multidomain/facet/enrichmenthelper.hh
+++ b/dumux/multidomain/facet/enrichmenthelper.hh
@@ -20,7 +20,7 @@
/*!
* \file
* \ingroup FacetCoupling
- * \brief copydoc Dumux::VertexEnrichmentHelper
+ * \copydoc Dumux::VertexEnrichmentHelper
*/
#ifndef DUMUX_VERTEX_ENRICHMENT_HELPER_HH
#define DUMUX_VERTEX_ENRICHMENT_HELPER_HH
diff --git a/dumux/multidomain/facet/vertexmapper.hh b/dumux/multidomain/facet/vertexmapper.hh
index c3afdf141e3d60f6666286449265bef85dbb7f0e..5b67f39076e385917e31143fc21bf7211493d4dc 100644
--- a/dumux/multidomain/facet/vertexmapper.hh
+++ b/dumux/multidomain/facet/vertexmapper.hh
@@ -20,7 +20,7 @@
/*!
* \file
* \ingroup FacetCoupling
- * \brief copydoc Dumux::EnrichedVertexDofMapper
+ * \copydoc Dumux::EnrichedVertexDofMapper
*/
#ifndef DUMUX_ENRICHED_VERTEX_DOF_MAPPER_HH
#define DUMUX_ENRICHED_VERTEX_DOF_MAPPER_HH
diff --git a/dumux/nonlinear/findscalarroot.hh b/dumux/nonlinear/findscalarroot.hh
index 9eff421612f716515155b01d43fd514b705b7168..20bb5c65d1c148674a576fdf394e3a93d265bd03 100644
--- a/dumux/nonlinear/findscalarroot.hh
+++ b/dumux/nonlinear/findscalarroot.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Common
+ * \ingroup Nonlinear
* \brief Root finding algorithms for scalar functions
*/
#ifndef DUMUX_COMMON_SCALAR_ROOT_FINDING_HH
@@ -35,7 +35,7 @@
namespace Dumux {
/*!
- * \ingroup Common
+ * \ingroup Nonlinear
* \brief Newton's root finding algorithm for scalar functions (secant method)
* \param xOld initial guess
* \param residual Residual function
@@ -76,7 +76,7 @@ Scalar findScalarRootNewton(Scalar xOld, const ResFunc& residual, const DerivFun
}
/*!
- * \ingroup Common
+ * \ingroup Nonlinear
* \brief Newton's root finding algorithm for scalar functions (secant method)
* \note The derivative is numerically computed. If the derivative is know use signature with derivative function.
* \param xOld initial guess
@@ -95,7 +95,7 @@ Scalar findScalarRootNewton(Scalar xOld, const ResFunc& residual,
}
/*!
- * \ingroup Common
+ * \ingroup Nonlinear
* \brief Brent's root finding algorithm for scalar functions
* \note Modified from pseudo-code on wikipedia: https://en.wikipedia.org/wiki/Brent%27s_method
* \note See also R.P. Brent "An algorithm with guaranteed convergence for finding a zero of a function", The Computer Journal (1971).
diff --git a/dumux/parallel/vectorcommdatahandle.hh b/dumux/parallel/vectorcommdatahandle.hh
index e2bc4c4f34ce11ee71d5f173c1d8c44a3e9f55cf..74122a6ec7902060a5b86200954affe531558c5f 100644
--- a/dumux/parallel/vectorcommdatahandle.hh
+++ b/dumux/parallel/vectorcommdatahandle.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Linear
+ * \ingroup Parallel
* \brief Contains a class to exchange entries of a vector
*/
#ifndef DUMUX_VECTOR_COMM_DATA_HANDLE_HH
@@ -69,7 +69,7 @@ namespace Detail {
} // end namespace Detail
/*!
- * \ingroup Linear
+ * \ingroup Parallel
* \brief A data handle class to exchange entries of a vector
*/
template<class Mapper, class Vector, int entityCodim, class ScatterOperator>
diff --git a/dumux/parallel/vertexhandles.hh b/dumux/parallel/vertexhandles.hh
index 0faa96649f2ff23e3c9b54c4ab236b2791b7933c..e6b014acca7d4e82567b580e55cdca3e1f57caca 100644
--- a/dumux/parallel/vertexhandles.hh
+++ b/dumux/parallel/vertexhandles.hh
@@ -18,7 +18,7 @@
*****************************************************************************/
/*!
* \file
- * \ingroup Assembly
+ * \ingroup Parallel
* \brief Provides data handles for parallel communication which operate on vertices
* \note This is useful for schemes with degrees of freedom on vertices (box scheme)
*/
diff --git a/dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh b/dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh
index 63dad808af722e7200269410866d62b692b5b2a0..5dcb9055d4709a45a61b3f4f123f9802c5779b2b 100644
--- a/dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh
+++ b/dumux/porousmediumflow/2p/boxmaterialinterfaceparams.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup TwoPModel
- * \brief copydoc Dumux::BoxMaterialInterfaceParams
+ * \copydoc Dumux::BoxMaterialInterfaceParams
*/
#ifndef DUMUX_2P_BOX_MATERIAL_INTERFACE_PARAMS_HH
diff --git a/dumux/porousmediumflow/2p/saturationreconstruction.hh b/dumux/porousmediumflow/2p/saturationreconstruction.hh
index 07365f6fe7868b6a01025886ecb2a5556facf65f..7398f0d6ce6d6c0bcac357047219825085b1ea2b 100644
--- a/dumux/porousmediumflow/2p/saturationreconstruction.hh
+++ b/dumux/porousmediumflow/2p/saturationreconstruction.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup TwoPModel
- * \brief copydoc Dumux::TwoPScvSaturationReconstruction
+ * \copydoc Dumux::TwoPScvSaturationReconstruction
*/
#ifndef DUMUX_2P_SCV_SATURATION_RECONSTRUCTION_HH
diff --git a/dumux/porousmediumflow/2p2c/sequential/celldatamultiphysics.hh b/dumux/porousmediumflow/2p2c/sequential/celldatamultiphysics.hh
index 5fc987ea1864284ad93d5f2fe0985f676ec7fb8f..3d0d06a9a3d3a293effcc39494c6b66427610980 100644
--- a/dumux/porousmediumflow/2p2c/sequential/celldatamultiphysics.hh
+++ b/dumux/porousmediumflow/2p2c/sequential/celldatamultiphysics.hh
@@ -95,7 +95,7 @@ public:
else
return this->fluidState_->pressure(phaseIdx);
}
- //! \copydoc CellData2P2C::setPressure()
+ //! DOC ME!
void setPressure(int phaseIdx, Scalar value)
{
if(fluidStateType_ == simple)
diff --git a/dumux/porousmediumflow/mpnc/model.hh b/dumux/porousmediumflow/mpnc/model.hh
index 4d2ed7d63e13f99eca3718ac87189dee5c6f5696..0f3e397778bb4ff7af057e7215b97e054d0a2650 100644
--- a/dumux/porousmediumflow/mpnc/model.hh
+++ b/dumux/porousmediumflow/mpnc/model.hh
@@ -119,10 +119,6 @@
#include "localresidual.hh"
#include "pressureformulation.hh"
-/*!
- * \ingroup MPNCModel
- * \brief Defines the properties required for the MpNc fully implicit model.
- */
namespace Dumux
{
diff --git a/test/multidomain/boundary/stokesdarcy/1p_1p/convergencetest/problem_darcy.hh b/test/multidomain/boundary/stokesdarcy/1p_1p/convergencetest/problem_darcy.hh
index 2b92475b442861bb05e4420428d38801c8a89655..8312e44e9b12429eec836dde956fe79fe44690b3 100644
--- a/test/multidomain/boundary/stokesdarcy/1p_1p/convergencetest/problem_darcy.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p_1p/convergencetest/problem_darcy.hh
@@ -221,10 +221,7 @@ public:
* \brief Evaluates the source term for all phases within a given
* sub control volume.
*
- * \param element The element for which the source term is set
- * \param fvGeometry The fvGeometry
- * \param elemVolVars The element volume variables
- * \param scv The sub control volume
+ * \param globalPos The global position
*/
NumEqVector sourceAtPos(const GlobalPosition& globalPos) const
{
@@ -260,7 +257,6 @@ public:
* \brief Returns the analytical solution of the problem at a given position.
*
* \param globalPos The global position
- * \param time The current simulation time
*/
auto analyticalSolution(const GlobalPosition& globalPos) const
{
diff --git a/test/multidomain/boundary/stokesdarcy/1p_1p/convergencetest/problem_stokes.hh b/test/multidomain/boundary/stokesdarcy/1p_1p/convergencetest/problem_stokes.hh
index 3a02f723dd0ba43181d822eda83f124e36c108d4..25cd89a66203d2d82adad33afc110421e570d1b5 100644
--- a/test/multidomain/boundary/stokesdarcy/1p_1p/convergencetest/problem_stokes.hh
+++ b/test/multidomain/boundary/stokesdarcy/1p_1p/convergencetest/problem_stokes.hh
@@ -266,7 +266,6 @@ public:
* \brief Returns the analytical solution of the problem at a given position.
*
* \param globalPos The global position
- * \param time The current simulation time
*/
PrimaryVariables analyticalSolution(const GlobalPosition& globalPos) const
{
diff --git a/test/porousmediumflow/2p/implicit/adaptive/main.cc b/test/porousmediumflow/2p/implicit/adaptive/main.cc
index 2e9778f5076b595425cd5b10166aab73959c622f..44512751dd6b98b8951df54778a2556f3e4ddb6a 100644
--- a/test/porousmediumflow/2p/implicit/adaptive/main.cc
+++ b/test/porousmediumflow/2p/implicit/adaptive/main.cc
@@ -56,12 +56,12 @@
#include <dumux/porousmediumflow/2p/griddatatransfer.hh>
#include <dumux/porousmediumflow/2p/gridadaptindicator.hh>
-//! Use the incompressible or point source problem for this adaptive test
+// Use the incompressible or point source problem for this adaptive test
#include <test/porousmediumflow/2p/implicit/incompressible/problem.hh>
#include "pointsourceproblem.hh"
#include "problem.hh"
-//! Type tags for the adaptive versions of the two-phase incompressible problem
+// Type tags for the adaptive versions of the two-phase incompressible problem
namespace Dumux {
namespace Properties {
//! Type Tags for the adaptive tests
diff --git a/test/porousmediumflow/2p/implicit/boxdfm/spatialparams.hh b/test/porousmediumflow/2p/implicit/boxdfm/spatialparams.hh
index 21e983c73eff2099e69bdaf6dabfcde6513045b7..5d0455254f81a265a3ccd89f82785c3bb62285d0 100644
--- a/test/porousmediumflow/2p/implicit/boxdfm/spatialparams.hh
+++ b/test/porousmediumflow/2p/implicit/boxdfm/spatialparams.hh
@@ -17,6 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \ingroup TwoPTests
* \brief The spatial params for the incompressible 2p test.
*/
diff --git a/test/porousmediumflow/2p/implicit/cornerpoint/spatialparams.hh b/test/porousmediumflow/2p/implicit/cornerpoint/spatialparams.hh
index e01602f20605655964480082f2feb4b8a9d835f1..22d56066eae216c2d03bbcec595c5da6ba461979 100644
--- a/test/porousmediumflow/2p/implicit/cornerpoint/spatialparams.hh
+++ b/test/porousmediumflow/2p/implicit/cornerpoint/spatialparams.hh
@@ -17,6 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \ingroup TwoPTests
* \brief The spatial params for the 2p cornerpoint test.
*/
diff --git a/test/porousmediumflow/2p/implicit/incompressible/spatialparams.hh b/test/porousmediumflow/2p/implicit/incompressible/spatialparams.hh
index d0912b6feefaf7f947921f4d4fc0888acdbfefde..1232ca5d2b4c72808481de848cc3484d0df8ac0f 100644
--- a/test/porousmediumflow/2p/implicit/incompressible/spatialparams.hh
+++ b/test/porousmediumflow/2p/implicit/incompressible/spatialparams.hh
@@ -17,6 +17,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
*****************************************************************************/
/*!
+ * \file
* \ingroup TwoPTests
* \brief The spatial params for the incompressible 2p test.
*/
diff --git a/test/porousmediumflow/3p/implicit/convection/problem.hh b/test/porousmediumflow/3p/implicit/convection/problem.hh
index 4ec0fbc1cd59fb417687548f171da2de3de55406..d712c39d1dcfba8ec83496f93dd65fa48a8f134e 100644
--- a/test/porousmediumflow/3p/implicit/convection/problem.hh
+++ b/test/porousmediumflow/3p/implicit/convection/problem.hh
@@ -38,7 +38,7 @@
#include <dumux/material/components/h2o.hh>
#include <dumux/material/fluidmatrixinteractions/3p/thermalconductivitysomerton3p.hh>
-#include "../conduction/spatialparams.hh" //! reuse the conduction spatialParams
+#include "../conduction/spatialparams.hh" // reuse the conduction spatialParams
namespace Dumux {
/**
diff --git a/test/porousmediumflow/tracer/multiphase/problem.hh b/test/porousmediumflow/tracer/multiphase/problem.hh
index 09cb2bf7ee7aaf007f2f8b2ab1578975e4b4a47a..3188361b54e650fb7483f1efcb627c9cd64cdd61 100644
--- a/test/porousmediumflow/tracer/multiphase/problem.hh
+++ b/test/porousmediumflow/tracer/multiphase/problem.hh
@@ -104,6 +104,7 @@ public:
* \param element The finite element
* \param fvGeometry The finite-volume geometry
* \param elemVolVars All volume variables for the element
+ * \param elemFluxVarsCache Flux variables caches for all faces in stencil
* \param scvf The sub control volume face
*
* Negative values mean influx.