Doxygen updates

This commit is contained in:
Harry Moffat 2010-08-23 18:00:01 +00:00
parent 9a8fe5b47e
commit d8caa353a0
5 changed files with 20 additions and 8 deletions

View file

@ -1,6 +1,9 @@
/** /**
* @file LiquidTransportData.cpp * @file LTPspecies.cpp \
* Source code for liquid transport property evaluations. * definitions for the LTPspecies objects and its children, which is the virtual base class
* for describing temperature dependence of submodels for transport parameters
* (see \ref tranprops and \link Cantera::LTPspecies LTPspecies \endlink) .
*
*/ */
/* /*
* $Author$ * $Author$

View file

@ -27,6 +27,8 @@ using namespace std;
namespace Cantera { namespace Cantera {
//! \cond
const int DeltaDegree = 6; const int DeltaDegree = 6;
double MMCollisionInt::delta[8] = {0.0, 0.25, 0.50, 0.75, 1.0, double MMCollisionInt::delta[8] = {0.0, 0.25, 0.50, 0.75, 1.0,
@ -226,6 +228,8 @@ namespace Cantera {
0.94863, 0.9487,0.9489,0.9491,0.9493,0.9491,0.9483,0.9476, 0.94863, 0.9487,0.9489,0.9491,0.9493,0.9491,0.9483,0.9476,
0.94444, 0.94444,0.94444,0.94444,0.94444,0.94444,0.94444,0.94444}; 0.94444, 0.94444,0.94444,0.94444,0.94444,0.94444,0.94444,0.94444};
//! \endcond
//==================================================================================================================== //====================================================================================================================
MMCollisionInt::MMCollisionInt() MMCollisionInt::MMCollisionInt()
{ {

View file

@ -27,7 +27,9 @@ using namespace std;
#ifndef SAFE_DELETE #ifndef SAFE_DELETE
//! \cond
#define SAFE_DELETE(x) if (x) { delete (x); x = 0; } #define SAFE_DELETE(x) if (x) { delete (x); x = 0; }
//! \endcond
#endif #endif
namespace Cantera { namespace Cantera {
@ -868,7 +870,7 @@ namespace Cantera {
return 0.0; return 0.0;
} }
//================================================================================================ //===================================================================================================================
} }
//================================================================================================ //======================================================================================================================

View file

@ -39,7 +39,7 @@ namespace Cantera {
/*! /*!
* \addtogroup tranprops * \addtogroup tranprops
*/ */
//@{ //! \cond
const int CK_Mode = 10; const int CK_Mode = 10;
@ -58,7 +58,7 @@ namespace Cantera {
const int cSimpleTransport = 770; const int cSimpleTransport = 770;
const int cRadiativeTransport = 800; const int cRadiativeTransport = 800;
const int cWaterTransport = 721; const int cWaterTransport = 721;
//@} //! \endcond
// forward reference // forward reference
class XML_Writer; class XML_Writer;
@ -899,7 +899,7 @@ namespace Cantera {
//! General definition for the transport class //! General definition for the transport class
/*! /*!
* \ingroups tranprops * \ingroup tranprops
*/ */
typedef Transport transport_t; typedef Transport transport_t;

View file

@ -42,7 +42,10 @@ namespace Cantera {
class WaterProps; class WaterProps;
class PDSS_Water; class PDSS_Water;
//! Transport Parameters for pure water
/*!
*
*/
class WaterTransport : public Transport { class WaterTransport : public Transport {
public: public: