Skip to content

Commit e616fa1

Browse files
committed
small fixes and add more groups
1 parent 142587b commit e616fa1

4 files changed

Lines changed: 15 additions & 5 deletions

File tree

Docs/docmain.hpp

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,11 @@
4848
* thus navigate the architecture from the bottom up (note that this will also be more effective if done
4949
* for base classes).
5050
*
51-
* ## Good practices when documenting a function
51+
* ### Good practices when documenting classes and functions
5252
*
5353
* The groups and subgroups defined in this file form a hierarchy of doxygen modules, when documenting a
5454
* class or free function it should be added to a group (member functions belong to the group of the class
55-
* by default), otherwise it will be difficult to navigate to the documentation.
55+
* by default), otherwise it will be difficult to navigate to the documentation of the class or function.
5656
* Therefore, all classes and functions should have a doxygen documentation block with at least \\brief and
5757
* \\ingroup properties.
5858
*
@@ -106,6 +106,11 @@
106106
* three formulations: direct, adjoint, and linearized.
107107
*/
108108

109+
/*!
110+
* \defgroup Scalar_Transport Solving scalar transport equations
111+
* \brief Classes to solve scalar transport equations.
112+
*/
113+
109114
/*!
110115
* \defgroup Elasticity_Equations Solving the elasticity equations
111116
* \brief Group of classes to solve solid deformation problems.
@@ -130,6 +135,11 @@
130135
* \brief Classes used to store and access the solution variables of all types of problems.
131136
*/
132137

138+
/*!
139+
* \defgroup Output Screen, history, and file output
140+
* \brief Classes used to define the output of the solvers in SU2.
141+
*/
142+
133143
/*!
134144
* \defgroup DiscAdj Discrete Adjoint
135145
* \brief Classes and functions used to solve discrete adjoint equations.

SU2_CFD/include/output/COutput.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,9 @@ class CConfig;
5858
using namespace std;
5959

6060
/*!
61-
* \class COutput
6261
* \brief Class for writing the convergence history and to write solution data to file.
6362
* \author T.Albring
63+
* \ingroup Output
6464
*/
6565
class COutput {
6666
protected:

SU2_CFD/include/solvers/CScalarSolver.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@
3333
#include "CSolver.hpp"
3434

3535
/*!
36-
* \class CScalarSolver
3736
* \brief Main class for defining a scalar solver.
3837
* \tparam VariableType - Class of variable used by the solver inheriting from this template.
38+
* \ingroup Scalar_Transport
3939
*/
4040
template <class VariableType>
4141
class CScalarSolver : public CSolver {

SU2_CFD/include/solvers/CSpeciesSolver.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@
3232
#include "CScalarSolver.hpp"
3333

3434
/*!
35-
* \class CSpeciesSolver
3635
* \brief Main class for defining the species transport solver.
3736
* \author T. Kattmann.
37+
* \ingroup Scalar_Transport
3838
*/
3939
class CSpeciesSolver : public CScalarSolver<CSpeciesVariable> {
4040
protected:

0 commit comments

Comments
 (0)