mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

strbuf.h: group documentation for trim functions

Browse Source 
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>
This commit is contained in:
Jeff King
2015-01-16 04:06:04 -05:00
committed by Junio C Hamano
parent f20e56e202
commit d468fa2721
1 changed files with 2 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
strbuf.h
View File

@ -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 *);
/** /**