From d468fa2721d1ff918c0991e9e1f762872b3f82ae Mon Sep 17 00:00:00 2001 From: Jeff King Date: Fri, 16 Jan 2015 04:06:04 -0500 Subject: [PATCH] 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 Signed-off-by: Junio C Hamano --- strbuf.h | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/strbuf.h b/strbuf.h index 61c9c73fe8..1883494ca3 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 *); /** -- 2.11.4.GIT