From b03eb0dc806cdd3deb62fa87f9e7f5e18f495fcf Mon Sep 17 00:00:00 2001
From: Rashad Kanavath <rashad.kanavath@c-s.fr>
Date: Thu, 24 Sep 2015 10:48:47 +0200
Subject: [PATCH] DOC: add errmsg parameter into inline docs
---
Modules/Adapters/BoostAdapters/include/otbStringUtils.h | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
diff --git a/Modules/Adapters/BoostAdapters/include/otbStringUtils.h b/Modules/Adapters/BoostAdapters/include/otbStringUtils.h
index 1257f2336e..ec04cf3af1 100644
--- a/Modules/Adapters/BoostAdapters/include/otbStringUtils.h
+++ b/Modules/Adapters/BoostAdapters/include/otbStringUtils.h
@@ -48,8 +48,9 @@ T LexicalCast(std::string const& in, std::string const& kind) {
/**\ingroup Utils
* - 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
+ * \terrmsg - a msg to be shown if there is lexical_cast exception.
* \tparam delims - delimitter space is default
* \t param T& ret - std::vector of type T
*/
@@ -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
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:
str - reference to input string of type std::string
key - reference to std::string where key will be stored
value - reference to T where value will be stored
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 '='
doTrim - option to perform boost::trim() over key and values. Default is true.
*/
--
GitLab