From 38efb3d996f88af6063bfa67fa0beda4e18ca80b Mon Sep 17 00:00:00 2001 From: Harry Moffat Date: Mon, 9 Aug 2010 23:27:33 +0000 Subject: [PATCH] Doxygen update --- Cantera/src/base/misc.cpp | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/Cantera/src/base/misc.cpp b/Cantera/src/base/misc.cpp index ef1ef6507..feba01606 100644 --- a/Cantera/src/base/misc.cpp +++ b/Cantera/src/base/misc.cpp @@ -1891,9 +1891,13 @@ protected: #endif // WITH_HTML_LOGS - - /// split a string at a '#' sign. Used to separate a file name - /// from an id string. + //=============================================================================================================== + //! split a string at a '#' sign. Used to separate a file name from an id string. + /*! + * @param src Original string to be split up. This is unchanged. + * @param file Output string representing the first part of the string, which is the filename. + * @param id Output string representing the last part of the string, which is the id. + */ static void split_at_pound(const std::string& src, std::string& file, std::string& id) { string::size_type ipound = src.find('#'); if (ipound != string::npos) { @@ -1905,6 +1909,7 @@ protected: file = src; } } + //=============================================================================================================== /* * This routine will locate an XML node in either the input * XML tree or in another input file specified by the file