From 536d98a67f4567b664087ebd70414ef704a26013 Mon Sep 17 00:00:00 2001
From: Martin Utz <martin.utz@baw.de>
Date: Wed, 20 Apr 2022 08:42:40 +0200
Subject: [PATCH] [doxygen] Add blank lines after brief description
---
doc/doxygen/modules.txt | 39 +++++++++++++++++++++++++++++++++++++--
1 file changed, 37 insertions(+), 2 deletions(-)
diff --git a/doc/doxygen/modules.txt b/doc/doxygen/modules.txt
index 3c8f2f9749..db203fd525 100644
--- a/doc/doxygen/modules.txt
+++ b/doc/doxygen/modules.txt
@@ -14,78 +14,91 @@
* \ingroup PorousmediumflowModels
* \defgroup OnePModel 1p
* \brief Single-phase (immiscible) Darcy flow
+ *
* For a detailed model description see porousmediumflow/1p/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup OnePNCModel 1pnc
* \brief Single-phase, multi-component Darcy flow
+ *
* For a detailed model description see porousmediumflow/1pnc/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup OnePNCMinModel 1pncmin
* \brief Single-phase, multi-component Darcy flow with mineralization
+ *
* For a detailed model description see porousmediumflow/1pncmin/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TwoPModel 2p
* \brief Two-phase (immiscible) Darcy flow
+ *
* For a detailed model description see porousmediumflow/2p/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TwoPOneCModel 2p1c
* \brief Two-phase, one-component Darcy flow
+ *
* For a detailed model description see porousmediumflow/2p1c/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TwoPTwoCModel 2p2c
* \brief Two-phase, two-component Darcy flow
+ *
* For a detailed model description see porousmediumflow/2p2c/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TwoPNCModel 2pnc
* \brief two-phase, multi-component Darcy flow
+ *
* For a detailed model description see porousmediumflow/2pnc/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TwoPNCMinModel 2pncmin
* \brief Two-phase, multi-component Darcy flow with mineralization
+ *
* For a detailed model description see porousmediumflow/2pncmin/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup ThreePModel 3p
* \brief Three-phase (immiscible) Darcy flow
+ *
* For a detailed model description see porousmediumflow/3p/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup ThreePThreeCModel 3p3c
* \brief Three-phase, three-component Darcy flow
+ *
* For a detailed model description see porousmediumflow/3p3c/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup ThreePWaterOilModel 3pwateroil
* \brief Three-phase, two-component Darcy flow with water (liquid & gas) and oil
+ *
* For a detailed model description see porousmediumflow/3pwateroil/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup BoxDFMModel boxdfm
* \brief Vertex-centered, continuous-pressure, conforming lower-dimensional discrete-fracture model
+ *
* For a detailed model description 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
+ *
* For a detailed model description see porousmediumflow/co2/model.hh
*/
/*!
@@ -106,12 +119,14 @@
* \ingroup PorousmediumflowModels
* \defgroup NonEquilibriumModel NonEquilibrium
* \brief Model that adds nonequilibrium equations to another porous medium flow model (only used in MPNCModel currently)
+ *
* For a detailed model description see porousmediumflow/nonequilibrium/model.hh
*/
/*!
* \ingroup NonEquilibriumModel
* \defgroup ThermalNonEquilibriumModel ThermalNonEquilibrium
* \brief Model that adapts the energy localresidual to thermal nonequilibrium
+ *
* For a detailed model description see porousmediumflow/nonequilibrium/thermal/localresidual.hh
*/
/*!
@@ -125,24 +140,28 @@
* \ingroup PorousmediumflowModels
* \defgroup RichardsModel Richards
* \brief Richards flow
+ *
* For a detailed model description see porousmediumflow/richards/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup RichardsNCModel Richards nc
* \brief Richards multi-component flow
+ *
* For a detailed model description see porousmediumflow/richardsnc/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup SolidEnergyModel Solid energy
* \brief Energy equation for the solid (general heat equation)
+ *
* For a detailed model description see porousmediumflow/solidenergy/model.hh
*/
/*!
* \ingroup PorousmediumflowModels
* \defgroup TracerModel Tracer
* \brief Multi-component advection-diffusion-reaction model with given velocity field
+ *
* For a detailed model description see porousmediumflow/tracer/model.hh
*/
@@ -155,24 +174,28 @@
* \ingroup FreeflowModels
* \defgroup NavierStokesModel Navier-Stokes
* \brief Single-phase Navier-Stokes flow
+ *
* For a detailed model description see freeflow/navierstokes/model.hh
*/
/*!
* \ingroup FreeflowModels
* \defgroup RANSModel Reynolds-Averaged Navier-Stokes
* \brief Single-phase Reynolds-Averaged Navier-Stokes flow
+ *
* For a detailed model description see freeflow/rans/model.hh
*/
/*!
* \ingroup RANSModel
* \defgroup ZeroEqModel 0-Eq. Models
* \brief Zero-equation or algebraic turbulence models
+ *
* For a detailed model description see freeflow/rans/zeroeq/model.hh
*/
/*!
* \ingroup RANSModel
* \defgroup OneEqModel 1-Eq. Models
* \brief One-equation turbulence model by Spalart-Allmaras
+ *
* For a detailed model description see freeflow/rans/oneeq/model.hh
*/
/*!
@@ -184,42 +207,49 @@
* \ingroup TwoEqModel
* \defgroup KEpsilonModel K-epsilon model
* \brief K-epsilon model
+ *
* For a detailed model description see freeflow/rans/twoeq/kepsilon/model.hh
*/
/*!
* \ingroup TwoEqModel
* \defgroup KOmegaModel K-omega model
* \brief K-omega model
+ *
* For a detailed model description 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 description see freeflow/rans/twoeq/lowrekepsilon/model.hh
*/
/*!
* \ingroup TwoEqModel
* \defgroup SSTModel SST model
* \brief SST model
+ *
* For a detailed model description see freeflow/rans/twoeq/sst/model.hh
*/
/*!
* \ingroup FreeflowModels
* \defgroup FreeflowNCModel Compositional
* \brief Single-phase multi-component free-flow flow models
+ *
* For a detailed model description see freeflow/compositional/navierstokesncmodel.hh
*/
/*!
* \ingroup FreeflowModels
* \defgroup FreeflowNIModel Nonisothermal
* \brief An energy equation adaptor for isothermal free-flow models
+ *
* For a detailed model description see freeflow/nonisothermal/model.hh
*/
/*!
* \ingroup FreeflowModels
* \defgroup ShallowWaterModel 2D shallow water model
* \brief Two-dimensional shallow water flow (depth-averaged)
+ *
* For a detailed model description see freeflow/shallowwater/model.hh
*/
/*!
@@ -230,12 +260,14 @@
* \ingroup Geomechanics
* \defgroup Elastic Solid mechanics w/o fluid pressure
* \brief Models linear elastic deformation of a solid. Disregards fluid pressure.
+ *
* For a detailed model description 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.
+ *
* For a detailed model description see geomechanics/poroelastic/model.hh
*/
/*!
@@ -569,12 +601,12 @@
/*!
* \ingroup MultiDomain
* \defgroup EmbeddedCoupling Embedded mixed-dimension coupling mode
- * \brief Couples problems of different dimensions where one or more lower-dimensional problems (lowdim) are embedded in a higher-dimensional domain (bulk). Examples are embedded one-dimensional networks for the simulation of blood tissue perfusion, or root-soil interaction, and embedded fracture models.
+ * \brief Couples problems of different dimensions where one or more lower-dimensional problems (lowdim) are embedded in a higher-dimensional domain (bulk). Examples are embedded one-dimensional networks for the simulation of blood tissue perfusion, or root-soil interaction, and embedded fracture models.
*/
/*!
* \ingroup MultiDomain
* \defgroup FacetCoupling Conforming mixed-dimension facet coupling mode
- * \brief Couples problems of different dimensions where one or more lower-dimensional problems (lowdim) live on the facets of the higher-dimensional domain (bulk). Examples are discrete facet conforming fracture models and problems with physics on a domain surface.
+ * \brief Couples problems of different dimensions where one or more lower-dimensional problems (lowdim) live on the facets of the higher-dimensional domain (bulk). Examples are discrete facet conforming fracture models and problems with physics on a domain surface.
*/
/* ***************** PoreNetwork ******************/
@@ -586,18 +618,21 @@
* \ingroup PoreNetworkModels
* \defgroup PNMOnePModel 1p
* \brief Single-phase (immiscible) flow
+ *
* For a detailed model description see porenetwork/1p/model.hh
*/
/*!
* \ingroup PoreNetworkModels
* \defgroup PNMOnePNCModel 1pnc
* \brief Single-phase, multi-component flow
+ *
* For a detailed model description see porenetwork/1pnc/model.hh
*/
/*!
* \ingroup PoreNetworkModels
* \defgroup PNMTwoPModel 2p
* \brief Two-phase (immiscible) flow
+ *
* For a detailed model description see porenetwork/2p/model.hh
*/
--
GitLab