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>
Jeff King committed
Jan 16, 2015 at 04:06 UTC
d468fa2721d1ff918c0991e9e1f762872b3f82ae
1 file changed
+2
-10
strbuf.h
+2
-10
@@ -164,19 +164,11 @@ static inline void strbuf_setlen(struct strbuf *sb, size_t len)
164
*/
165
166
/**
167
- * Strip whitespace from the beginning and end of a string.
168
- * Equivalent to performing `strbuf_rtrim()` followed by `strbuf_ltrim()`.
167
+ * Strip whitespace from the beginning (`ltrim`), end (`rtrim`), or both side
168
+ * (`trim`) of a string.
169
*/
170
extern void strbuf_trim(struct strbuf *);
171
-
172
-/**
173
- * Strip whitespace from the end of a string.
174
- */
171
extern void strbuf_rtrim(struct strbuf *);
176
-
177
-/**
178
- * Strip whitespace from the beginning of a string.
179
- */
172
extern void strbuf_ltrim(struct strbuf *);
173
174
/**