Changed the comments on one file.

This commit is contained in:
Harry Moffat 2010-05-04 23:59:16 +00:00
parent 75d434fc31
commit 82e215d732

View file

@ -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;