diff options
| author |  Brian Gesiak <modocache@gmail.com> | 2014-04-30 17:58:07 +0900 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2014-05-06 15:33:58 -0700 |
| commit | 10f5b034b6aaff706c4776b3cc0ee993c33e8f43 (patch) | |
| tree | a58db5789d19a16013fee1dee93f1e3b3c3d7913 | |
| parent | strbuf: use _rtrim and _ltrim in strbuf_trim (diff) | |
| download | tgif-10f5b034b6aaff706c4776b3cc0ee993c33e8f43.tar.xz | |
api-strbuf.txt: add docs for _trim and _ltrim
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>
Reviewed-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/technical/api-strbuf.txt | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Documentation/technical/api-strbuf.txt b/Documentation/technical/api-strbuf.txt index 3350d97dda..4396be9dda 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 |