[PATCH 7/7] strbuf.h: group documentation for trim functions
From: Jeff King <hidden>
Date: 2016-06-15 23:03:36
Subsystem:
the rest · Maintainer:
Linus Torvalds
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 <redacted> --- strbuf.h | 12 ++---------- 1 file 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 *); /**
--
2.2.1.425.g441bb3c