From bec52296246bd315d2374de8e8facb79670ad73c Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Thu, 15 Mar 2007 23:09:44 +0000 Subject: [PATCH] doxygen update Changed the name of WaterTP to WaterSSTP in a few places. --- Cantera/src/thermo/WaterSSTP.cpp | 5 +++-- Cantera/src/thermo/WaterSSTP.h | 24 ++++++++++++------------ tools/doc/Cantera.cfg.in | 2 +- 3 files changed, 16 insertions(+), 15 deletions(-) diff --git a/Cantera/src/thermo/WaterSSTP.cpp b/Cantera/src/thermo/WaterSSTP.cpp index 1d2b47388..d50037383 100644 --- a/Cantera/src/thermo/WaterSSTP.cpp +++ b/Cantera/src/thermo/WaterSSTP.cpp @@ -1,6 +1,7 @@ /** - * @file WaterTP.cpp - * + * @file WaterSSTP.cpp + * Definitions for the Object WaterSSTP, which creates a + * single species ThermoPhase object for real liquid water. */ /* * Copywrite (2006) Sandia Corporation. Under the terms of diff --git a/Cantera/src/thermo/WaterSSTP.h b/Cantera/src/thermo/WaterSSTP.h index 13bc09c0a..49beb3dfb 100644 --- a/Cantera/src/thermo/WaterSSTP.h +++ b/Cantera/src/thermo/WaterSSTP.h @@ -132,21 +132,21 @@ namespace Cantera { //@{ - //!Get the gibbs function for the species - //! standard states at the current T and P of the solution. + //! Get the gibbs function for the species + //! standard states at the current T and P of the solution. /*! - * @param grt Vector of length m_kk, which on return sr[k] + * @param gss Vector of length m_kk, which on return * will contain the - * standard state gibbs function for species k. + * standard state gibbs function for species k. */ virtual void getStandardChemPotentials(doublereal* gss) const; //!Get the nondimensional gibbs function for the species //! standard states at the current T and P of the solution. /*! - * @param grt Vector of length m_kk, which on return sr[k] + * @param grt Vector of length m_kk, which on return * will contain the nondimensional - * standard state gibbs function for species k. + * standard state gibbs function for species k */ virtual void getGibbs_RT(doublereal* grt) const; @@ -154,9 +154,9 @@ namespace Cantera { //! at the current T and P of the solution. /*! * - * @param hrt Vector of length m_kk, which on return hrt[k] + * @param hrt Vector of length m_kk, which on return * will contain the nondimensional - * standard state enthalpy of species k. + * standard state enthalpy of species k */ void getEnthalpy_RT(doublereal* hrt) const; @@ -164,9 +164,9 @@ namespace Cantera { //! Get the nondimensional Entropies for the species //! standard states at the current T and P of the solution. /*! - * @param sr Vector of length m_kk, which on return sr[k] + * @param sr Vector of length m_kk, which on return * will contain the nondimensional - * standard state entropy for species k. + * standard state entropy for speciesk */ void getEntropy_R(doublereal* sr) const; @@ -174,9 +174,9 @@ namespace Cantera { //! function for the species standard states at the current T and P of the solution. /*! * - * @param cpr Vector of length m_kk, which on return cpr[k] + * @param cpr Vector of length m_kk, which on return * will contain the nondimensional - * constant pressure heat capacity for species k. + * constant pressure heat capacity for species k */ virtual void getCp_R(doublereal* cpr) const; diff --git a/tools/doc/Cantera.cfg.in b/tools/doc/Cantera.cfg.in index 509bd2726..95b3d318c 100755 --- a/tools/doc/Cantera.cfg.in +++ b/tools/doc/Cantera.cfg.in @@ -120,7 +120,7 @@ FILE_PATTERNS = Kinetics.h Kinetics.cpp \ ConstDensityThermo.h ConstDensityThermo.cpp \ WaterPropsIAPWSphi.h WaterPropsIAPWSphi.cpp \ WaterPropsIAPWS.h WaterPropsIAPWS.cpp \ - WaterTP.h WaterTP.cpp \ + WaterSSTP.h WaterSSTP.cpp \ PureFluidPhase.h PureFluidPhase.cpp \ equil.h RECURSIVE = NO