From 5f7e88a634ba017af6e96653a2d8f47bfa2126f5 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Fri, 25 Sep 2009 20:15:28 +0000 Subject: [PATCH] Added missing doxygen documentation --- Cantera/src/equil/vcs_internal.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Cantera/src/equil/vcs_internal.h b/Cantera/src/equil/vcs_internal.h index d4fd32eeb..6756c4a7a 100644 --- a/Cantera/src/equil/vcs_internal.h +++ b/Cantera/src/equil/vcs_internal.h @@ -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