From 4dd28c417a25134ecd4c6f1f851a4107daa28f42 Mon Sep 17 00:00:00 2001 From: Ingmar Schoegl Date: Fri, 28 Jul 2023 17:57:03 -0600 Subject: [PATCH] [docs] Fix brief documentation --- include/cantera/zeroD/ConstPressureMoleReactor.h | 2 +- include/cantera/zeroD/IdealGasConstPressureMoleReactor.h | 3 ++- include/cantera/zeroD/IdealGasMoleReactor.h | 3 ++- include/cantera/zeroD/MoleReactor.h | 3 ++- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/include/cantera/zeroD/ConstPressureMoleReactor.h b/include/cantera/zeroD/ConstPressureMoleReactor.h index 74c6cf84ab..a34197a7e4 100644 --- a/include/cantera/zeroD/ConstPressureMoleReactor.h +++ b/include/cantera/zeroD/ConstPressureMoleReactor.h @@ -11,7 +11,7 @@ namespace Cantera { -/*! +/** * ConstPressureMoleReactor is a class for constant-pressure reactors * which use a state of moles. * @since New in %Cantera 3.0 diff --git a/include/cantera/zeroD/IdealGasConstPressureMoleReactor.h b/include/cantera/zeroD/IdealGasConstPressureMoleReactor.h index 0bd863f6dc..c9938d85b6 100644 --- a/include/cantera/zeroD/IdealGasConstPressureMoleReactor.h +++ b/include/cantera/zeroD/IdealGasConstPressureMoleReactor.h @@ -11,9 +11,10 @@ namespace Cantera { -/*! +/** * IdealGasConstPressureMoleReactor is a class for ideal gas constant-pressure reactors * which use a state of moles. + * @since New in %Cantera 3.0 * @ingroup reactorGroup */ class IdealGasConstPressureMoleReactor : public ConstPressureMoleReactor diff --git a/include/cantera/zeroD/IdealGasMoleReactor.h b/include/cantera/zeroD/IdealGasMoleReactor.h index 5df2201036..0363aeacb9 100644 --- a/include/cantera/zeroD/IdealGasMoleReactor.h +++ b/include/cantera/zeroD/IdealGasMoleReactor.h @@ -11,9 +11,10 @@ namespace Cantera { -/*! +/** * IdealGasMoleReactor is a class for ideal gas constant-volume reactors which use a * state of moles. + * @since New in %Cantera 3.0 * @ingroup reactorGroup */ class IdealGasMoleReactor : public MoleReactor diff --git a/include/cantera/zeroD/MoleReactor.h b/include/cantera/zeroD/MoleReactor.h index 3cb6dbae05..b308272245 100644 --- a/include/cantera/zeroD/MoleReactor.h +++ b/include/cantera/zeroD/MoleReactor.h @@ -11,9 +11,10 @@ namespace Cantera { -/*! +/** * MoleReactor is meant to serve the same purpose as the reactor class but with a state * vector composed of moles. It also serves as the base class for other mole reactors. + * @since New in %Cantera 3.0 * @ingroup reactorGroup */ class MoleReactor : public Reactor