From: Richard Heck <rgheck@comcast.net>
Date: Wed, 16 Jul 2008 14:49:36 +0000 (+0000)
Subject: Clarify comments.
X-Git-Tag: 1.6.10~4040
X-Git-Url: https://git.lyx.org/gitweb/?a=commitdiff_plain;h=ab6ecc9fea75e6d87125a2e43dbd7d835191507c;p=features.git

Clarify comments.


git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@25668 a592a061-630c-0410-9148-cb99ea01b6c8
---

diff --git a/src/support/lstrings.h b/src/support/lstrings.h
index 01f72383ae..3b86053ace 100644
--- a/src/support/lstrings.h
+++ b/src/support/lstrings.h
@@ -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 = " ");