From 82e215d73292c31430bfe12bcdaa5ebc1801c431 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Tue, 4 May 2010 23:59:16 +0000 Subject: [PATCH] Changed the comments on one file. --- Cantera/src/thermo/Constituents.h | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/Cantera/src/thermo/Constituents.h b/Cantera/src/thermo/Constituents.h index a38622906..22028b964 100644 --- a/Cantera/src/thermo/Constituents.h +++ b/Cantera/src/thermo/Constituents.h @@ -280,14 +280,13 @@ namespace Cantera { doublereal charge = 0.0, doublereal size = 1.0); - //! Index of species named 'name' + //! Returns the index of a species named 'name' within the ThermoPhase /*! - * The first species added - * will have index 0, and the last one index nSpecies() - 1. + * The first species added will have index 0, and the last one index nSpecies() - 1. * * @param name String name of the species - * @return - * Returns the index of the species. + * @return Returns the index of the species. If the name is not found + * the value of -1 is returned. */ int speciesIndex(std::string name) const;