From 436bed3868a639ee2f59e16effb44f42ecf8f43d Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Wed, 21 Sep 2011 01:03:45 +0000 Subject: [PATCH] Added doxygen fixes --- Cantera/src/thermo/Constituents.h | 4 ++++ Cantera/src/thermo/Elements.h | 3 +-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Cantera/src/thermo/Constituents.h b/Cantera/src/thermo/Constituents.h index 3a31522c3..3f4e1b3fd 100644 --- a/Cantera/src/thermo/Constituents.h +++ b/Cantera/src/thermo/Constituents.h @@ -191,6 +191,8 @@ namespace Cantera { * the value ENTROPY298_UNKNOWN, which is * interpreted as an unknown, and if used * will cause Cantera to throw an error. + * @param elem_type Specifies the type of the element constraint equation. This defaults + * to CT_ELEM_TYPE_ABSPOS, i.e., an element. */ void addUniqueElement(const std::string& symbol, doublereal weight, int atomicNumber = 0, @@ -230,6 +232,8 @@ namespace Cantera { * the value ENTROPY298_UNKNOWN, which is * interpreted as an unknown, and if used * will cause Cantera to throw an error. + * @param elem_type Specifies the type of the element constraint equation. This defaults + * to CT_ELEM_TYPE_ABSPOS, i.e., an element. */ int addUniqueElementAfterFreeze(const std::string& symbol, doublereal weight, int atomicNumber, doublereal entropy298 = ENTROPY298_UNKNOWN, int elem_type = CT_ELEM_TYPE_ABSPOS); diff --git a/Cantera/src/thermo/Elements.h b/Cantera/src/thermo/Elements.h index 8f738acad..f0c46cb18 100644 --- a/Cantera/src/thermo/Elements.h +++ b/Cantera/src/thermo/Elements.h @@ -59,8 +59,7 @@ namespace Cantera { */ #define CT_ELEM_TYPE_CHARGENEUTRALITY 2 - //! Constraint associated with maintaing a fixed lattice stoichiometry int eh - //! solids + //! Constraint associated with maintaing a fixed lattice stoichiometry in a solid /*! * The constraint may have positive or negative values. The lattice 0 species will * have negative values while higher lattices will have positive values