From 10f5b034b6aaff706c4776b3cc0ee993c33e8f43 Mon Sep 17 00:00:00 2001 From: Brian Gesiak Date: Wed, 30 Apr 2014 17:58:07 +0900 Subject: 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 Reviewed-by: Jeff King Signed-off-by: Junio C Hamano --- Documentation/technical/api-strbuf.txt | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'Documentation/technical') 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 -- cgit v1.2.3