mirror of
https://github.com/git/git
synced 2024-08-27 19:49:21 +00:00
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>
This commit is contained in:
parent
bdfdaa4978
commit
6afbbdda33
14
strbuf.h
14
strbuf.h
|
@ -435,7 +435,7 @@ static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
|
|||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* Split str (of length slen) at the specified terminator character.
|
||||
* Return a null-terminated array of pointers to strbuf objects
|
||||
* holding the substrings. The substrings include the terminator,
|
||||
|
@ -451,7 +451,7 @@ static inline int strbuf_strip_suffix(struct strbuf *sb, const char *suffix)
|
|||
extern struct strbuf **strbuf_split_buf(const char *, size_t,
|
||||
int terminator, int max);
|
||||
|
||||
/*
|
||||
/**
|
||||
* Split a NUL-terminated string at the specified terminator
|
||||
* character. See strbuf_split_buf() for more information.
|
||||
*/
|
||||
|
@ -461,7 +461,7 @@ static inline struct strbuf **strbuf_split_str(const char *str,
|
|||
return strbuf_split_buf(str, strlen(str), terminator, max);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* Split a strbuf at the specified terminator character. See
|
||||
* strbuf_split_buf() for more information.
|
||||
*/
|
||||
|
@ -471,7 +471,7 @@ static inline struct strbuf **strbuf_split_max(const struct strbuf *sb,
|
|||
return strbuf_split_buf(sb->buf, sb->len, terminator, max);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* Split a strbuf at the specified terminator character. See
|
||||
* strbuf_split_buf() for more information.
|
||||
*/
|
||||
|
@ -481,7 +481,7 @@ static inline struct strbuf **strbuf_split(const struct strbuf *sb,
|
|||
return strbuf_split_max(sb, terminator, 0);
|
||||
}
|
||||
|
||||
/*
|
||||
/**
|
||||
* Free a NULL-terminated list of strbufs (for example, the return
|
||||
* values of the strbuf_split*() functions).
|
||||
*/
|
||||
|
@ -498,7 +498,7 @@ extern int launch_editor(const char *path, struct strbuf *buffer, const char *co
|
|||
|
||||
extern void strbuf_add_lines(struct strbuf *sb, const char *prefix, const char *buf, size_t size);
|
||||
|
||||
/*
|
||||
/**
|
||||
* Append s to sb, with the characters '<', '>', '&' and '"' converted
|
||||
* into XML entities.
|
||||
*/
|
||||
|
@ -523,7 +523,7 @@ extern int fprintf_ln(FILE *fp, const char *fmt, ...);
|
|||
|
||||
char *xstrdup_tolower(const char *);
|
||||
|
||||
/*
|
||||
/**
|
||||
* Create a newly allocated string using printf format. You can do this easily
|
||||
* with a strbuf, but this provides a shortcut to save a few lines.
|
||||
*/
|
||||
|
|
Loading…
Reference in a new issue