summaryrefslogtreecommitdiff
path: root/apt-pkg
diff options
context:
space:
mode:
authorMichael Vogt <mvo@ubuntu.com>2013-10-01 12:03:37 +0200
committerMichael Vogt <mvo@ubuntu.com>2013-10-01 12:03:37 +0200
commit41053d721ce7f81652d7e873067376b94f9a060d (patch)
tree2f75dbcd4cd94b57bbe54af070ba65ccb53d10f0 /apt-pkg
parent9572a54bbc96eb653b3e13260abb183ba7a316f3 (diff)
improve documentation for StringSplit()
Diffstat (limited to 'apt-pkg')
-rw-r--r--apt-pkg/contrib/strutl.cc6
-rw-r--r--apt-pkg/contrib/strutl.h19
2 files changed, 19 insertions, 6 deletions
diff --git a/apt-pkg/contrib/strutl.cc b/apt-pkg/contrib/strutl.cc
index fd768f183..96c6d2f35 100644
--- a/apt-pkg/contrib/strutl.cc
+++ b/apt-pkg/contrib/strutl.cc
@@ -1120,11 +1120,9 @@ vector<string> VectorizeString(string const &haystack, char const &split)
/*}}}*/
// StringSplit - split a string into a string vector by token /*{{{*/
// ---------------------------------------------------------------------
-/* This can be used to split a given string up from a given string token
- * into a vector of strings. A optional "maxsplit" argument can be used
- * to limit the splitting, in this case the
+/* See header for details.
*/
-vector<string> StringSplit(string const &s, std::string const &sep,
+vector<string> StringSplit(std::string const &s, std::string const &sep,
unsigned int maxsplit)
{
vector<string> split;
diff --git a/apt-pkg/contrib/strutl.h b/apt-pkg/contrib/strutl.h
index 080f9f82e..eb47287a4 100644
--- a/apt-pkg/contrib/strutl.h
+++ b/apt-pkg/contrib/strutl.h
@@ -70,8 +70,23 @@ bool TokSplitString(char Tok,char *Input,char **List,
// split a given string by a char
std::vector<std::string> VectorizeString(std::string const &haystack, char const &split) __attrib_const;
-// split a given string by a string token
-std::vector<std::string> StringSplit(std::string const &input, std::string const &sep, unsigned int maxsplit=0) __attrib_const;
+/* \brief Return a vector of strings from string "input" where "sep"
+ * is used as the delimiter string.
+ *
+ * \param input The input string.
+ *
+ * \param sep The seperator to use.
+ *
+ * \param maxsplit (optional) The maximum amount of splitting that
+ * should be done .
+ *
+ * The optional "maxsplit" argument can be used to limit the splitting,
+ * if used the string is only split on maxsplit places and the last
+ * item in the vector contains the remainder string.
+ */
+std::vector<std::string> StringSplit(std::string const &input,
+ std::string const &sep,
+ unsigned int maxsplit=0) __attrib_const;
void ioprintf(std::ostream &out,const char *format,...) __like_printf(2);
void strprintf(std::string &out,const char *format,...) __like_printf(2);