diff options
| author | Etienne Samson <samson.etienne@gmail.com> | 2019-06-13 20:17:01 +0200 |
|---|---|---|
| committer | Etienne Samson <samson.etienne@gmail.com> | 2019-06-15 16:15:50 +0200 |
| commit | 764196fffb76b5ddefb378910877c737778cb500 (patch) | |
| tree | 3571b27b97798edb755010bd9b6f5237e9c9c22c /include/git2/refs.h | |
| parent | 2376fa6c65a80e23d24393328212a80765d7ba94 (diff) | |
| download | libgit2-764196fffb76b5ddefb378910877c737778cb500.tar.gz | |
doc: add missing documentation comments
Diffstat (limited to 'include/git2/refs.h')
| -rw-r--r-- | include/git2/refs.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/include/git2/refs.h b/include/git2/refs.h index 8eeab7e92..c9cce2212 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -422,7 +422,26 @@ GIT_EXTERN(int) git_reference_remove(git_repository *repo, const char *name); */ GIT_EXTERN(int) git_reference_list(git_strarray *array, git_repository *repo); +/** + * Callback used to iterate over references + * + * @see git_reference_foreach + * + * @param reference The reference object + * @param payload Payload passed to git_reference_foreach + * @return non-zero to terminate the iteration + */ typedef int GIT_CALLBACK(git_reference_foreach_cb)(git_reference *reference, void *payload); + +/** + * Callback used to iterate over reference names + * + * @see git_reference_foreach_name + * + * @param name The reference name + * @param payload Payload passed to git_reference_foreach_name + * @return non-zero to terminate the iteration + */ typedef int GIT_CALLBACK(git_reference_foreach_name_cb)(const char *name, void *payload); /** |
