summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen Straub <bs@github.com>2012-11-26 19:53:04 -0800
committerBen Straub <bs@github.com>2012-11-27 13:18:29 -0800
commiteac7695683d03f9716a7ca04006b9b6c43976a15 (patch)
tree0c51e5767d0e8d339b05694bf47e09607d7aff76
parent4ff192d3f224c780c741e62146c3350e54cba759 (diff)
downloadlibgit2-eac7695683d03f9716a7ca04006b9b6c43976a15.tar.gz
Format/documentation tweaks for merge.h
-rw-r--r--include/git2/merge.h14
1 files changed, 12 insertions, 2 deletions
diff --git a/include/git2/merge.h b/include/git2/merge.h
index 37b1c787d..59493969c 100644
--- a/include/git2/merge.h
+++ b/include/git2/merge.h
@@ -27,8 +27,13 @@ GIT_BEGIN_DECL
* @param repo the repository where the commits exist
* @param one one of the commits
* @param two the other commit
+ * @return Zero on success; GIT_ENOTFOUND or -1 on failure.
*/
-GIT_EXTERN(int) git_merge_base(git_oid *out, git_repository *repo, const git_oid *one, const git_oid *two);
+GIT_EXTERN(int) git_merge_base(
+ git_oid *out,
+ git_repository *repo,
+ const git_oid *one,
+ const git_oid *two);
/**
* Find a merge base given a list of commits
@@ -37,8 +42,13 @@ GIT_EXTERN(int) git_merge_base(git_oid *out, git_repository *repo, const git_oid
* @param repo the repository where the commits exist
* @param input_array oids of the commits
* @param length The number of commits in the provided `input_array`
+ * @return Zero on success; GIT_ENOTFOUND or -1 on failure.
*/
-GIT_EXTERN(int) git_merge_base_many(git_oid *out, git_repository *repo, const git_oid input_array[], size_t length);
+GIT_EXTERN(int) git_merge_base_many(
+ git_oid *out,
+ git_repository *repo,
+ const git_oid input_array[],
+ size_t length);
/** @} */
GIT_END_DECL