diff options
author | Jeff King <peff@peff.net> | 2015-01-16 04:06:04 -0500 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2015-01-16 14:40:47 -0800 |
commit | d468fa2721d1ff918c0991e9e1f762872b3f82ae (patch) | |
tree | 121c1e9a112fe531da72e49ae2f7d5f9d148403a | |
parent | strbuf.h: drop boilerplate descriptions of strbuf_split_* (diff) | |
download | tgif-d468fa2721d1ff918c0991e9e1f762872b3f82ae.tar.xz |
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>
-rw-r--r-- | strbuf.h | 12 |
1 files changed, 2 insertions, 10 deletions
@@ -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. - * Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`. + * Strip whitespace from the beginning (`ltrim`), end (`rtrim`), or both side + * (`trim`) of a string. */ extern void strbuf_trim(struct strbuf *); - -/** - * Strip whitespace from the end of a string. - */ extern void strbuf_rtrim(struct strbuf *); - -/** - * Strip whitespace from the beginning of a string. - */ extern void strbuf_ltrim(struct strbuf *); /** |