From 012586fe01927af9e0f3fc76730705ba2e566985 Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Mon, 12 Jan 2009 19:39:14 +0000 Subject: [PATCH] Doxygen update --- Cantera/src/base/stringUtils.cpp | 2 +- Cantera/src/base/stringUtils.h | 16 +++++++++++++++- 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/Cantera/src/base/stringUtils.cpp b/Cantera/src/base/stringUtils.cpp index 275f92bd9..48a990c17 100755 --- a/Cantera/src/base/stringUtils.cpp +++ b/Cantera/src/base/stringUtils.cpp @@ -138,7 +138,7 @@ namespace Cantera { /** * Strip non-printing characters. */ - std::string stripnonprint(std::string s) { + std::string stripnonprint(const std::string &s) { int i; int n = static_cast(s.size()); std::string ss = ""; diff --git a/Cantera/src/base/stringUtils.h b/Cantera/src/base/stringUtils.h index a8c61f330..374c89a4b 100755 --- a/Cantera/src/base/stringUtils.h +++ b/Cantera/src/base/stringUtils.h @@ -62,8 +62,22 @@ namespace Cantera { */ std::string stripws(const std::string &s); - std::string stripnonprint(std::string s); + //! Strip non-printing characters wherever they are + /*! + * @param s Input string + * @return Returns a copy of the string, + * stripped of all non-printing characters. + */ + std::string stripnonprint(const std::string &s); + + //! Cast a copy of a string to lower case + /*! + * @param s Input string + * @return Returns a copy of the string, + * with all characters lowercase. + */ std::string lowercase(const std::string &s); + void parseCompString(const std::string ss, compositionMap& x); void split(const std::string ss, std::vector& w); int fillArrayFromString(const std::string& str, doublereal* a, char delim = ' ');