File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 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 *
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.
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.
Original file line number Diff line number Diff line change @@ -58,9 +58,9 @@ class CConfig;
5858using 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 */
6565class COutput {
6666protected:
Original file line number Diff line number Diff line change 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 */
4040template <class VariableType >
4141class CScalarSolver : public CSolver {
Original file line number Diff line number Diff line change 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 */
3939class CSpeciesSolver : public CScalarSolver <CSpeciesVariable> {
4040 protected:
You can’t perform that action at this time.
0 commit comments