From d8caa353a06f88dfd790c598efaff192d61e2312 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Mon, 23 Aug 2010 18:00:01 +0000 Subject: [PATCH] Doxygen updates --- Cantera/src/transport/LTPspecies.cpp | 7 +++++-- Cantera/src/transport/MMCollisionInt.cpp | 4 ++++ Cantera/src/transport/SimpleTransport.cpp | 6 ++++-- Cantera/src/transport/TransportBase.h | 6 +++--- Cantera/src/transport/WaterTransport.h | 5 ++++- 5 files changed, 20 insertions(+), 8 deletions(-) diff --git a/Cantera/src/transport/LTPspecies.cpp b/Cantera/src/transport/LTPspecies.cpp index aa8f8dbb2..74ce83edb 100644 --- a/Cantera/src/transport/LTPspecies.cpp +++ b/Cantera/src/transport/LTPspecies.cpp @@ -1,6 +1,9 @@ /** - * @file LiquidTransportData.cpp - * Source code for liquid transport property evaluations. + * @file LTPspecies.cpp \ + * 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$ diff --git a/Cantera/src/transport/MMCollisionInt.cpp b/Cantera/src/transport/MMCollisionInt.cpp index d4949529a..a1b7d5750 100644 --- a/Cantera/src/transport/MMCollisionInt.cpp +++ b/Cantera/src/transport/MMCollisionInt.cpp @@ -27,6 +27,8 @@ using namespace std; namespace Cantera { + + //! \cond const int DeltaDegree = 6; 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.94444, 0.94444,0.94444,0.94444,0.94444,0.94444,0.94444,0.94444}; + //! \endcond + //==================================================================================================================== MMCollisionInt::MMCollisionInt() { diff --git a/Cantera/src/transport/SimpleTransport.cpp b/Cantera/src/transport/SimpleTransport.cpp index 680f77805..405baedee 100644 --- a/Cantera/src/transport/SimpleTransport.cpp +++ b/Cantera/src/transport/SimpleTransport.cpp @@ -27,7 +27,9 @@ using namespace std; #ifndef SAFE_DELETE +//! \cond #define SAFE_DELETE(x) if (x) { delete (x); x = 0; } +//! \endcond #endif namespace Cantera { @@ -868,7 +870,7 @@ namespace Cantera { return 0.0; } - //================================================================================================ + //=================================================================================================================== } -//================================================================================================ +//====================================================================================================================== diff --git a/Cantera/src/transport/TransportBase.h b/Cantera/src/transport/TransportBase.h index 1b2650fe8..d9f3d10d6 100644 --- a/Cantera/src/transport/TransportBase.h +++ b/Cantera/src/transport/TransportBase.h @@ -39,7 +39,7 @@ namespace Cantera { /*! * \addtogroup tranprops */ - //@{ + //! \cond const int CK_Mode = 10; @@ -58,7 +58,7 @@ namespace Cantera { const int cSimpleTransport = 770; const int cRadiativeTransport = 800; const int cWaterTransport = 721; - //@} + //! \endcond // forward reference class XML_Writer; @@ -899,7 +899,7 @@ namespace Cantera { //! General definition for the transport class /*! - * \ingroups tranprops + * \ingroup tranprops */ typedef Transport transport_t; diff --git a/Cantera/src/transport/WaterTransport.h b/Cantera/src/transport/WaterTransport.h index e95fadcda..c8ad75a67 100644 --- a/Cantera/src/transport/WaterTransport.h +++ b/Cantera/src/transport/WaterTransport.h @@ -42,7 +42,10 @@ namespace Cantera { class WaterProps; class PDSS_Water; - + //! Transport Parameters for pure water + /*! + * + */ class WaterTransport : public Transport { public: