summaryrefslogtreecommitdiff
path: root/strbuf.h
diff options
context:
space:
mode:
authorStefan Beller <sbeller@google.com>2015-01-16 04:04:51 -0500
committerJunio C Hamano <gitster@pobox.com>2015-01-16 14:40:46 -0800
commit6afbbdda3339349feae91161f4e530d511c4db76 (patch)
treeba99a043122224b74d1bc571770ac01530523578 /strbuf.h
parentbdfdaa4978dd92992737e662f25adc01d32d0774 (diff)
downloadgit-6afbbdda3339349feae91161f4e530d511c4db76.tar.gz
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>
Diffstat (limited to 'strbuf.h')
-rw-r--r--strbuf.h14
1 files changed, 7 insertions, 7 deletions
diff --git a/strbuf.h b/strbuf.h
index b4050de0ce..fd57e45049 100644
--- a/strbuf.h
+++ b/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.
*/