]> git.lyx.org Git - features.git/commitdiff
Clarify comments.
authorRichard Heck <rgheck@comcast.net>
Wed, 16 Jul 2008 14:49:36 +0000 (14:49 +0000)
committerRichard Heck <rgheck@comcast.net>
Wed, 16 Jul 2008 14:49:36 +0000 (14:49 +0000)
git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@25668 a592a061-630c-0410-9148-cb99ea01b6c8

src/support/lstrings.h

index 01f72383ae8a2c9eacdd0adb8ad89dded7f97770..3b86053ace1b345d7fa89c7d1b85083335510abb 100644 (file)
@@ -183,9 +183,10 @@ docstring const trim(docstring const & a, char const * p = " ");
 */
 std::string const trim(std::string const & a, char const * p = " ");
 
-/** Trims characters off the end of a string.
+/** Trims characters off the end of a string, removing any character
+    in p.
     \code
-    rtrim("abccc", "c") == "ab".
+    rtrim("abcde", "dec") == "ab".
     \endcode
 */
 std::string const rtrim(std::string const & a, char const * p = " ");
@@ -193,7 +194,7 @@ docstring const rtrim(docstring const & a, char const * p = " ");
 
 /** Trims characters off the beginning of a string.
     \code
-   ("ababcdef", "ab") = "cdef"
+   ("abbabcdef", "ab") = "cdef"
     \endcode
 */
 std::string const ltrim(std::string const & a, char const * p = " ");