Browse Source

strbuf.h: group documentation for trim functions

The relationship between these makes more sense if you read
them as a group, which can help people who are looking for
the right function. Let's give them a single comment.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Jeff King 10 years ago committed by Junio C Hamano
parent
commit
d468fa2721
  1. 12
      strbuf.h

12
strbuf.h

@ -164,19 +164,11 @@ static inline void strbuf_setlen(struct strbuf *sb, size_t len)
*/ */


/** /**
* Strip whitespace from the beginning and end of a string. * Strip whitespace from the beginning (`ltrim`), end (`rtrim`), or both side
* Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`. * (`trim`) of a string.
*/ */
extern void strbuf_trim(struct strbuf *); extern void strbuf_trim(struct strbuf *);

/**
* Strip whitespace from the end of a string.
*/
extern void strbuf_rtrim(struct strbuf *); extern void strbuf_rtrim(struct strbuf *);

/**
* Strip whitespace from the beginning of a string.
*/
extern void strbuf_ltrim(struct strbuf *); extern void strbuf_ltrim(struct strbuf *);


/** /**

Loading…
Cancel
Save