Changes between Version 1 and Version 2 of code/doc/String

Timestamp:

Sep 24, 2008, 5:51:59 PM (16 years ago)

Author:

landauf

Comment:

—

code/doc/String

@@ -4 +4 @@
 String defines several useful functions for string manipulation. The following list gives a short overview:
 
- * '''strip('''''string* pointer''''')''': 
- * '''getStripped('''''string''''')''': 
+ * '''strip('''''string* pointer''''')''': Removes all whitespaces from a string. See ''getStripped'' for examples.
+ * '''getStripped('''''string''''')''': Removes all whitespaces and returns the modified string.
+  * Example: getStripped(" test abc\tabc test\nThis is a newline! ") = "testabcabctestThisisanewline!"
 
- * '''removeTrailingWhitespaces('''''string''''')''': 
+ * '''removeTrailingWhitespaces('''''string''''')''': Removes trailing whitespace and returns the modified string.
+  * Example:
+{{{
+#!html
+<span style="white-space:pre;">removeTrailingWhitespaces("    test      abc    ") = "test      abc"</span>
+}}}
 
- * '''getNextQuote('''''string''''', '''''start''''')''': 
- * '''isBetweenQuotes('''''string''''', '''''position''''')''': 
+ * '''getNextQuote('''''string''''', '''''start''''')''': Returns the position of the next quote in the string, starting with start.
+  * Examples:
+   * getNextQuote("123\"567\"9", 0) = 4
+   * getNextQuote("123\"567\"9", 4) = 4
+   * getNextQuote("123\"567\"9", 6) = 8
+   * getNextQuote("123\"567\"9", 9) = std::npos
+ * '''isBetweenQuotes('''''string''''', '''''position''''')''': Returns true if ''position'' is between two quotes.
+  * Examples:
+   * isBetweenQuotes("123\"567\"9", 1) = false
+   * isBetweenQuotes("123\"567\"9", 4) = false
+   * isBetweenQuotes("123\"567\"9", 5) = true
+   * isBetweenQuotes("123\"567\"9", 8) = false
+   * isBetweenQuotes("123\"567\"9", 9) = false
 
- * '''hasStringBetweenQuotes('''''string''''')''': 
- * '''getStringBetweenQuotes('''''string''''')''': 
+ * '''hasStringBetweenQuotes('''''string''''')''': Returns true if the string contains something like '..."between quotes"...'.
+  * Examples:
+   * hasStringBetweenQuotes("test") = false
+   * hasStringBetweenQuotes("test\"abc") = false
+   * hasStringBetweenQuotes("test\"abc\"") = true
+ * '''getStringBetweenQuotes('''''string''''')''': If the string contains something like '..."between quotes"...' then 'between quotes' gets returned (without quotes).
+  * Examples:
+   * hasStringBetweenQuotes("test") = ""
+   * hasStringBetweenQuotes("test\"abc") = ""
+   * hasStringBetweenQuotes("test\"abc\"") = "abc"
 
- * '''stripEnclosingQuotes('''''string''''')''': 
- * '''stripEnclosingBraces('''''string''''')''': 
+ * '''stripEnclosingQuotes('''''string''''')''': Removes enclosing quotes if available (including whitespaces at the outside of the quotes).
+  * Examples:
+   * stripEnclosingQuotes(" \"hello!\" ") = "hello!"
+   * stripEnclosingQuotes(" \"hello! ") = " \"hello! "
+ * '''stripEnclosingBraces('''''string''''')''': Removes enclosing {braces} (braces must be exactly on the beginning and the end of the string).
+  * Examples:
+   * stripEnclosingBraces("{test}") = "test"
+   * stripEnclosingBraces(" {test}") = " {test}"
+   * stripEnclosingBraces("{ test }") = " test "
 
  * '''isEmpty('''''string''''')''':