update code docs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
diff --git a/include/git2/message.h b/include/git2/message.h
index e3c9fe7..3293462 100644
--- a/include/git2/message.h
+++ b/include/git2/message.h
@@ -38,11 +38,20 @@ GIT_BEGIN_DECL
*/
GIT_EXTERN(int) git_message_prettify(git_buf *out, const char *message, int strip_comments, char comment_char);
+/**
+ * Represents a single git message trailer.
+ */
typedef struct {
const char *key;
const char *value;
} git_message_trailer;
+/**
+ * Represents an array of git message trailers.
+ *
+ * Struct members under the private comment are private, subject to change
+ * and should not be used by callers.
+ */
typedef struct {
git_message_trailer *trailers;
size_t count;
@@ -52,9 +61,7 @@ typedef struct {
} git_message_trailer_array;
/**
- * Parse trailers out of a message, calling a callback once for each trailer.
- *
- * Return non-zero from the callback to stop processing.
+ * Parse trailers out of a message, filling the array pointed to by +arr+.
*
* Trailers are key/value pairs in the last paragraph of a message, not
* including any patches or conflicts that may be present.
@@ -62,10 +69,14 @@ typedef struct {
* @param arr A pre-allocated git_message_trailer_array struct to be filled in
* with any trailers found during parsing.
* @param message The message to be parsed
- * @return 0 on success, or non-zero callback return value.
+ * @return 0 on success, or non-zero on error.
*/
GIT_EXTERN(int) git_message_trailers(git_message_trailer_array *arr, const char *message);
+/**
+ * Clean's up any allocated memory in the git_message_trailer_array filled by
+ * a call to git_message_trailers.
+ */
GIT_EXTERN(void) git_message_trailer_array_free(git_message_trailer_array *arr);
/** @} */