summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeff King <peff@peff.net>2015-01-16 09:06:04 (GMT)
committerJunio C Hamano <gitster@pobox.com>2015-01-16 22:40:47 (GMT)
commitd468fa2721d1ff918c0991e9e1f762872b3f82ae (patch)
tree121c1e9a112fe531da72e49ae2f7d5f9d148403a
parentf20e56e202fa2a6cd3faa1710ed9f600ba58ce1d (diff)
downloadgit-d468fa2721d1ff918c0991e9e1f762872b3f82ae.zip
git-d468fa2721d1ff918c0991e9e1f762872b3f82ae.tar.gz
git-d468fa2721d1ff918c0991e9e1f762872b3f82ae.tar.bz2
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.h12
1 files changed, 2 insertions, 10 deletions
diff --git a/strbuf.h b/strbuf.h
index 61c9c73..1883494 100644
--- a/strbuf.h
+++ b/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.
- * 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 *);
/**