From 764196fffb76b5ddefb378910877c737778cb500 Mon Sep 17 00:00:00 2001 From: Etienne Samson Date: Thu, 13 Jun 2019 20:17:01 +0200 Subject: doc: add missing documentation comments --- include/git2/refs.h | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) (limited to 'include/git2/refs.h') 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); /** -- cgit v1.2.1