From 4297e1ce11eaed1b3543557ce8f956242c34638b Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Wed, 30 Dec 2009 18:40:44 +0000 Subject: [PATCH] Doxygen commit. Added stuff to the tranprops group. --- Cantera/src/transport/TransportBase.h | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/Cantera/src/transport/TransportBase.h b/Cantera/src/transport/TransportBase.h index 4d22ab22a..fdf1a24f1 100644 --- a/Cantera/src/transport/TransportBase.h +++ b/Cantera/src/transport/TransportBase.h @@ -17,7 +17,7 @@ /** - * @defgroup tranprops Transport Properties + * @defgroup tranprops Transport Properties for Species in Phases * * @ingroup phases * @@ -36,6 +36,11 @@ namespace Cantera { class GasTransportParams; class LiquidTransportParams; + /*! + * \addtogroup tranprops + */ + //@{ + const int CK_Mode = 10; // types of transport models that can be constructed @@ -53,6 +58,7 @@ namespace Cantera { const int cSimpleTransport = 770; const int cRadiativeTransport = 800; const int cWaterTransport = 721; + //@} // forward reference class XML_Writer; @@ -75,9 +81,14 @@ namespace Cantera { * - VB_SPECIES_0 Diffusion velocities are based on the relative motion wrt species 0 * - VB_SPECIES_1 Diffusion velocities are based on the relative motion wrt species 1 * + * @ingroup tranprops */ typedef int VelocityBasis; + /*! + * \addtogroup tranprops + */ + //@{ //! Diffusion velocities are based on the mass averaged velocity const VelocityBasis VB_MASSAVG = -1; //! Diffusion velocities are based on the mole averaged velocities @@ -86,6 +97,7 @@ namespace Cantera { const VelocityBasis VB_SPECIES_0 = 0; //! Diffusion velocities are based on the relative motion wrt species 1 const VelocityBasis VB_SPECIES_1 = 1; + //@} //! Base class for transport property managers. /*! @@ -759,7 +771,10 @@ namespace Cantera { }; - //! general definition for the transport class + //! General definition for the transport class + /*! + * \ingroups tranprops + */ typedef Transport transport_t; }