Skip to content

Commit

Permalink
api-strbuf.txt: add docs for _trim and _ltrim
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Brian Gesiak authored and Junio C Hamano committed May 6, 2014
1 parent 3bb55e8 commit 10f5b03
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions Documentation/technical/api-strbuf.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 10f5b03

Please sign in to comment.