Changes
Page history
howtos: udpate styleguide for Doxygen headers
authored
Mar 07, 2020
by
Johannes Keller
Show whitespace changes
Inline
Side-by-side
howtos/styleguide.md
View page @
7d947f7c
...
...
@@ -147,22 +147,20 @@ Try to keep the lines below **80 characters**.
Example doxygen header:
```
fortran
!> @author Voker Rath (ag, rwth aachen)
!> @author Andreas Wolf (sc, rwth aachen)
!> @author Darius Mottaghy (ag, rwth aachen)
!> @author Henrik Buesing (gge, rwth aachen)
!> @date 31.08.2012
!> @brief main program for forward simulation (only)
!> @details
!>an forward and inverse aquifer simulation tool for coupled flow, heat transfer, and transport (time-dependent)\n
!>
!>based on numerical modules developed by: \n
!> - Jörn Bartels (gtn neubrandenburg gmbh)\n
!> - Michael Kühn (tu hamburg-harburg)\n
!> - Roland Wagner (ag,rwth aachen)\n
!> - Martin H. Bücker (sc,rwth aachen)\n
!> - Christof Clauser (ag,rwth aachen)\n
!> @details
!> **SHEMAT-Suite (Simulator for HEat and MAss Transport)** is a
!> numerical code for computing flow, heat and species transport
!> equations in porous media. The governing equations of the code are
!> the groundwater flow equation, the heat transport equation and the
!> species transport equation. \n\n
!>
!> SHEMAT-Suite includes parameter estimation and data assimilation
!> approaches, both stochastic (Monte Carlo, ensemble Kalman filter)
!> and deterministic (Bayesian inversion using automatic
!> differentiation for calculating derivatives).\n\n
!>
!> Note: To be able to use input file parsing with hdf5, the
!> hdf5-input-files have to be generated using the script:
!> `convert_to_hdf5.py`. This script can be found in the repository
...
...
@@ -171,9 +169,6 @@ Example doxygen header:
```
The header should always contain the following fields
*
`@author`
: Authors of the file.
*
`@date`
: Date of the (significant, not documentation, for example)
last change
*
`@brief`
: Brief description
*
`@details`
: Detailed description and notes, sources. Should recall
the brief description, so that the
`html`
from doxygen is nicely
...
...
...
...