strbuf.h: reorganize api function grouping headers
The original API doc had something like: Functions --------- * Life cycle ... some life-cycle functions ... * Related to the contents of the buffer ... functions related to contents .... etc This grouping can be hard to read in the comment sources, given the "*" in the comment lines, and the amount of text between each section. Instead, let's make a flat list of groupings, and underline each as a section header. That makes them stand out, and eliminates the weird half-phrase of "Related to...". Like: Functions related to the contents of the buffer ----------------------------------------------- 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:05 UTC
14e2177a40ca5861f0518cb6bbe0a6856ffa7552
1 file changed
+8
-9
strbuf.h
+8
-9
@@ -71,12 +71,8 @@ extern char strbuf_slopbuf[];
71
#define STRBUF_INIT { 0, 0, strbuf_slopbuf }
72
73
/**
74
- * Functions
75
- * ---------
76
- */
77
-
78
-/**
79
- * * Life Cycle
74
+ * Life Cycle Functions
75
+ * --------------------
76
*/
77
78
/**
@@ -120,7 +116,8 @@ static inline void strbuf_swap(struct strbuf *a, struct strbuf *b)
116
117
118
/**
123
- * * Related to the size of the buffer
119
+ * Functions related to the size of the buffer
120
+ * -------------------------------------------
121
*/
122
123
/**
@@ -162,7 +159,8 @@ static inline void strbuf_setlen(struct strbuf *sb, size_t len)
159
160
161
/**
165
- * * Related to the contents of the buffer
162
+ * Functions related to the contents of the buffer
163
+ * -----------------------------------------------
164
*/
165
166
/**
@@ -201,7 +199,8 @@ extern int strbuf_cmp(const struct strbuf *, const struct strbuf *);
199
200
201
/**
204
- * * Adding data to the buffer
202
+ * Adding data to the buffer
203
+ * -------------------------
204
*
205
* NOTE: All of the functions in this section will grow the buffer as
206
* necessary. If they fail for some reason other than memory shortage and the