[PATCH 2/2] api-strbuf.txt: Add docs for _trim and _ltrim
- From
Brian Gesiak <modocache@gmail.com>
- Date
- Apr 30, 2014, 08:58 UTC
- Message-ID
- <1398848287-77109-2-git-send-email-modocache@gmail.com>
- In-Reply-To
- <1398848287-77109-1-git-send-email-modocache@gmail.com>
API documentation for strbuf does not document strbuf_trim or strbuf_ltrim. Add documentation for these two functions.
Signed-off-by: Brian Gesiak <modocache@gmail.com> --- Documentation/technical/api-strbuf.txt | 9 +++++++++ 1 file changed, 9 insertions(+)
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index 3350d97..4396be9 100644 --- a/Documentation/technical/api-strbuf.txt +++ b/Documentation/technical/api-strbuf.txt @@ -121,10 +121,19 @@ Functions * Related to the contents of the buffer +`strbuf_trim`:: + + Strip whitespace from the beginning and end of a string. + Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`. + `strbuf_rtrim`:: Strip whitespace from the end of a string. +`strbuf_ltrim`:: + + Strip whitespace from the beginning of a string. + `strbuf_cmp`:: Compare two buffers. Returns an integer less than, equal to, or greater
-- 1.9.2.507.g779792a