diff options
Diffstat (limited to 'include/git2/branch.h')
| -rw-r--r-- | include/git2/branch.h | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/include/git2/branch.h b/include/git2/branch.h index 2f46720af..8bf7eb9d4 100644 --- a/include/git2/branch.h +++ b/include/git2/branch.h @@ -74,6 +74,8 @@ GIT_EXTERN(int) git_branch_delete( /** * Loop over all the branches and issue a callback for each one. * + * If the callback returns a non-zero value, this will stop looping. + * * @param repo Repository where to find the branches. * * @param list_flags Filtering flags for the branch @@ -84,7 +86,7 @@ GIT_EXTERN(int) git_branch_delete( * * @param payload Extra parameter to callback function. * - * @return 0 or an error code. + * @return 0 on success, GIT_EUSER on non-zero callback, or error code */ GIT_EXTERN(int) git_branch_foreach( git_repository *repo, |