Correcting comment on strip_strings and moving to doxygen

Author: thk123

src/util/string_utils.cpp

@@ -12,7 +12,7 @@ Author: Daniel Poetzl
 #include <cctype>
 #include <algorithm>
 
-/// Remove all whitespace characters from the end of a string. Whitespace
+/// Remove all whitespace characters from either end of a string. Whitespace
 /// in the middle of the string is left unchanged
 /// \param s: the string to strip
 /// \return The stripped string
@@ -34,6 +34,16 @@ std::string strip_string(const std::string &s)
   return s.substr(i, (j-i+1));
 }
 
+/// Given a string s, split into a sequence of substrings when separated by
+/// specified delimiter.
+/// \param s: The string to split up
+/// \param delim: The character to use as the delimiter
+/// \param [out] result: The sub strings
+/// \param strip: If true, strip_string will be used on each element, removing
+/// whitespace from the beginning and end of each element
+/// \param remove_empty: If true, all empty-string elements will be removed.
+/// This is applied after strip so whitespace only elements will be removed if
+/// both are set to true
 void split_string(
   const std::string &s,
   char delim,

src/util/string_utils.h

@@ -18,10 +18,10 @@ std::string strip_string(const std::string &s);
 
 void split_string(
   const std::string &s,
-  char delim, // must not be a whitespace character if strip is enabled
+  char delim,
   std::vector<std::string> &result,
-  bool strip = false,         // strip whitespace from the end of elements
-  bool remove_empty = false); // remove empty elements
+  bool strip = false,
+  bool remove_empty = false);
 
 void split_string(
   const std::string &s,