From ae7fc2f4f1703a915947f2a55b15727480573f7f Mon Sep 17 00:00:00 2001 From: Dave Goodwin Date: Wed, 25 Apr 2007 00:05:26 +0000 Subject: [PATCH] added doc --- Cantera/src/SpeciesThermoMgr.h | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/Cantera/src/SpeciesThermoMgr.h b/Cantera/src/SpeciesThermoMgr.h index 033323bfd..c82aef6e1 100755 --- a/Cantera/src/SpeciesThermoMgr.h +++ b/Cantera/src/SpeciesThermoMgr.h @@ -342,17 +342,21 @@ namespace Cantera { std::map speciesToType; }; - //! This species thermo manager requires that all species have the same parameterization. + //! This species thermo manager requires that all species have the + //! same parameterization. /*! * - * This is a templated class. The first template is called SPM. SPM is an object - * that calculates the thermo for one species. This class contains a vector of SPM's, - * one for each species. Together, the vector of SPM's is itself a SpeciesThermo class. + * This is a templated class. The first template is called SPM. SPM + * is an object that calculates the thermo for one species. This + * class contains a vector of SPM's, one for each + * species. Together, the vector of SPM's is itself a SpeciesThermo + * class. * - * @todo The form of the template class, SPM, is basically unspecified. it needs to be - * nailed down to a specific form. One way to do this is with a virtual base class - * formulation. Note, that the specification could be that it inherits from - * the class SpeciesThermo, itself. + * @todo The form of the template class, SPM, is basically + * unspecified. it needs to be nailed down to a specific + * form. One way to do this is with a virtual base class + * formulation. Note, that the specification could be that it + * inherits from the class SpeciesThermo, itself. * * @deprecated Note this is currently unused and it may be on its way out. *