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>
Brian Gesiak committed
Apr 30, 2014 at 17:58 UTC
10f5b034b6aaff706c4776b3cc0ee993c33e8f43
1 file changed
+9
Documentation/technical/api-strbuf.txt
+9
@@ -121,10 +121,19 @@ Functions
121
122
* Related to the contents of the buffer
123
124
+`strbuf_trim`::
125
+
126
+ Strip whitespace from the beginning and end of a string.
127
+ Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`.
128
+
129
`strbuf_rtrim`::
130
131
Strip whitespace from the end of a string.
132
133
+`strbuf_ltrim`::
134
+
135
+ Strip whitespace from the beginning of a string.
136
+
137
`strbuf_cmp`::
138
139
Compare two buffers. Returns an integer less than, equal to, or greater