Skip to content
Snippets Groups Projects
Commit b03eb0dc authored by Rashad Kanavath's avatar Rashad Kanavath
Browse files

DOC: add errmsg parameter into inline docs

parent bd2bf249
No related branches found
No related tags found
No related merge requests found
...@@ -48,8 +48,9 @@ T LexicalCast(std::string const& in, std::string const& kind) { ...@@ -48,8 +48,9 @@ T LexicalCast(std::string const& in, std::string const& kind) {
/**\ingroup Utils /**\ingroup Utils
* - convert a delimitter seperated string to std::vector of type T * - convert a delimitter seperated string to std::vector of type T
* \tparam vec - std::vector of type T. Specialized boost::lexical_cast is used * \tparam vec - std::vector of type T.
* \tparam str - input string * \tparam str - input string
* \terrmsg - a msg to be shown if there is lexical_cast exception.
* \tparam delims - delimitter space is default * \tparam delims - delimitter space is default
* \t param T& ret - std::vector of type T * \t param T& ret - std::vector of type T
*/ */
...@@ -74,14 +75,12 @@ SplitStringToSingleKeyValue - split a given std::string of into key value based ...@@ -74,14 +75,12 @@ SplitStringToSingleKeyValue - split a given std::string of into key value based
on given delimitter string. default delimitter is '='. If the string doesnot on given delimitter string. default delimitter is '='. If the string doesnot
have a delimitter the key is set to input string and value is set to defValue. have a delimitter the key is set to input string and value is set to defValue.
This function is templated over value type. It uses specialized
boost::lexical_cast if the T is not of type std::string. only primitive types
Arugments are: Arugments are:
str - reference to input string of type std::string str - reference to input string of type std::string
key - reference to std::string where key will be stored key - reference to std::string where key will be stored
value - reference to T where value will be stored value - reference to T where value will be stored
defValue - default value if there is no delimitter found. (informally TRUE) defValue - default value if there is no delimitter found. (informally TRUE)
errmsg - a msg to be shown if there is lexical_cast exception.
delims - const std::string which contains the delimtter used. Default is '=' delims - const std::string which contains the delimtter used. Default is '='
doTrim - option to perform boost::trim() over key and values. Default is true. doTrim - option to perform boost::trim() over key and values. Default is true.
*/ */
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment