Skip to content

Commit 6afbbdd

Browse files
stefanbellergitster
authored andcommitted
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 <[email protected]> Signed-off-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent bdfdaa4 commit 6afbbdd

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

strbuf.h

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
435435
return 0;
436436
}
437437

438-
/*
438+
/**
439439
* Split str (of length slen) at the specified terminator character.
440440
* Return a null-terminated array of pointers to strbuf objects
441441
* holding the substrings. The substrings include the terminator,
@@ -451,7 +451,7 @@ static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
451451
extern struct strbuf **strbuf_split_buf(const char *, size_t,
452452
int terminator, int max);
453453

454-
/*
454+
/**
455455
* Split a NUL-terminated string at the specified terminator
456456
* character. See strbuf_split_buf() for more information.
457457
*/
@@ -461,7 +461,7 @@ static inline struct strbuf **strbuf_split_str(const char *str,
461461
return strbuf_split_buf(str, strlen(str), terminator, max);
462462
}
463463

464-
/*
464+
/**
465465
* Split a strbuf at the specified terminator character. See
466466
* strbuf_split_buf() for more information.
467467
*/
@@ -471,7 +471,7 @@ static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
471471
return strbuf_split_buf(sb->buf, sb->len, terminator, max);
472472
}
473473

474-
/*
474+
/**
475475
* Split a strbuf at the specified terminator character. See
476476
* strbuf_split_buf() for more information.
477477
*/
@@ -481,7 +481,7 @@ static inline struct strbuf **strbuf_split(const struct strbuf *sb,
481481
return strbuf_split_max(sb, terminator, 0);
482482
}
483483

484-
/*
484+
/**
485485
* Free a NULL-terminated list of strbufs (for example, the return
486486
* values of the strbuf_split*() functions).
487487
*/
@@ -498,7 +498,7 @@ extern int launch_editor(const char *path, struct strbuf *buffer, const char *co
498498

499499
extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
500500

501-
/*
501+
/**
502502
* Append s to sb, with the characters '<', '>', '&' and '"' converted
503503
* into XML entities.
504504
*/
@@ -523,7 +523,7 @@ extern int fprintf_ln(FILE *fp, const char *fmt, ...);
523523

524524
char *xstrdup_tolower(const char *);
525525

526-
/*
526+
/**
527527
* Create a newly allocated string using printf format. You can do this easily
528528
* with a strbuf, but this provides a shortcut to save a few lines.
529529
*/

0 commit comments

Comments
 (0)