research/cantera
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added missing doxygen documentation

Browse source
This commit is contained in:
Harry Moffat 2009-09-25 20:15:28 +00:00
parent b093f02473
commit 5f7e88a634
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
Cantera/src/equil/vcs_internal.h
View file

@ -474,6 +474,15 @@ namespace VCSnonideal {
*/
void vcs_print_line(const char *str, int num);
//! Returns a const char string representing the type of the
//! species given by the first argument
/*!
* @param speciesStatus Species status integer representing the type
* of the species.
* @param length Maximum length of the string to be returned.
* Shorter values will yield abbreviated strings.
* Defaults to a value of 100.
*/
const char *vcs_speciesType_string(int speciesStatus, int length = 100);
//! Print a string within a given space limit