Skip to content

Commit

Permalink
[docs] Fix brief documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ischoegl committed Jul 29, 2023
1 parent 60cf624 commit 5b0fb19
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
4 changes: 2 additions & 2 deletions include/cantera/zeroD/ConstPressureMoleReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
namespace Cantera
{

/*!
/**
* ConstPressureMoleReactor is a class for constant-pressure reactors
* which use a state of moles.
* @since New in Cantera 3.0
* @since New in %Cantera 3.0
* @ingroup reactorGroup
*/
class ConstPressureMoleReactor : public MoleReactor
Expand Down
3 changes: 2 additions & 1 deletion include/cantera/zeroD/IdealGasConstPressureMoleReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion include/cantera/zeroD/IdealGasMoleReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion include/cantera/zeroD/MoleReactor.h
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5b0fb19

Please sign in to comment.