api-strbuf.txt: add docs for _trim and _ltrim
authorBrian Gesiak <modocache@gmail.com>
Wed, 30 Apr 2014 08:58:07 +0000 (17:58 +0900)
committerJunio C Hamano <gitster@pobox.com>
Tue, 6 May 2014 22:33:58 +0000 (15:33 -0700)
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>
Documentation/technical/api-strbuf.txt
index 3350d97dda2408f92dc44c1e3216facc50257a50..4396be9dda07dfad679f834120b7f1aa2adb16c5 100644 (file)
@@ -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