strbuf.h: unify documentation comments beginnings
The prior patch uses "/**" to denote "documentation" comments that we pulled from api-strbuf.txt. Let's use a consistent style for similar comments that were already in strbuf.h. Signed-off-by: Stefan Beller <sbeller@google.com> Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Stefan Beller committed
Jan 16, 2015 at 04:04 UTC
6afbbdda3339349feae91161f4e530d511c4db76
1 file changed
+7
-7
strbuf.h
+7
-7
@@ -435,7 +435,7 @@ static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
435
return 0;
436
}
437
438
-/*
438
+/**
439
* Split str (of length slen) at the specified terminator character.
440
* Return a null-terminated array of pointers to strbuf objects
441
* holding the substrings. The substrings include the terminator,
@@ -451,7 +451,7 @@ static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
451
extern struct strbuf **strbuf_split_buf(const char *, size_t,
452
int terminator, int max);
453
454
-/*
454
+/**
455
* Split a NUL-terminated string at the specified terminator
456
* character. See strbuf_split_buf() for more information.
457
*/
@@ -461,7 +461,7 @@ static inline struct strbuf **strbuf_split_str(const char *str,
461
return strbuf_split_buf(str, strlen(str), terminator, max);
462
}
463
464
-/*
464
+/**
465
* Split a strbuf at the specified terminator character. See
466
* strbuf_split_buf() for more information.
467
*/
@@ -471,7 +471,7 @@ static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
471
return strbuf_split_buf(sb->buf, sb->len, terminator, max);
472
}
473
474
-/*
474
+/**
475
* Split a strbuf at the specified terminator character. See
476
* strbuf_split_buf() for more information.
477
*/
@@ -481,7 +481,7 @@ static inline struct strbuf **strbuf_split(const struct strbuf *sb,
481
return strbuf_split_max(sb, terminator, 0);
482
}
483
484
-/*
484
+/**
485
* Free a NULL-terminated list of strbufs (for example, the return
486
* values of the strbuf_split*() functions).
487
*/
@@ -498,7 +498,7 @@ extern int launch_editor(const char *path, struct strbuf *buffer, const char *co
498
499
extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
500
501
-/*
501
+/**
502
* Append s to sb, with the characters '<', '>', '&' and '"' converted
503
* into XML entities.
504
*/
@@ -523,7 +523,7 @@ extern int fprintf_ln(FILE *fp, const char *fmt, ...);
523
524
char *xstrdup_tolower(const char *);
525
526
-/*
526
+/**
527
* Create a newly allocated string using printf format. You can do this easily
528
* with a strbuf, but this provides a shortcut to save a few lines.
529
*/