diff options
Diffstat (limited to 'include/git2/refs.h')
| -rw-r--r-- | include/git2/refs.h | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/include/git2/refs.h b/include/git2/refs.h index 2760f9457..882e32769 100644 --- a/include/git2/refs.h +++ b/include/git2/refs.h @@ -28,7 +28,7 @@ GIT_BEGIN_DECL * @param reference_out pointer to the looked-up reference * @param repo the repository to look up the reference * @param name the long name for the reference (e.g. HEAD, ref/heads/master, refs/tags/v0.1.0, ...) - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_lookup(git_reference **reference_out, git_repository *repo, const char *name); @@ -59,7 +59,7 @@ GIT_EXTERN(int) git_reference_name_to_oid( * @param name The name of the reference * @param target The target of the reference * @param force Overwrite existing references - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_create_symbolic(git_reference **ref_out, git_repository *repo, const char *name, const char *target, int force); @@ -79,7 +79,7 @@ GIT_EXTERN(int) git_reference_create_symbolic(git_reference **ref_out, git_repos * @param name The name of the reference * @param id The object id pointed to by the reference. * @param force Overwrite existing references - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_create_oid(git_reference **ref_out, git_repository *repo, const char *name, const git_oid *id, int force); @@ -137,7 +137,7 @@ GIT_EXTERN(const char *) git_reference_name(git_reference *ref); * * @param resolved_ref Pointer to the peeled reference * @param ref The reference - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_resolve(git_reference **resolved_ref, git_reference *ref); @@ -160,7 +160,7 @@ GIT_EXTERN(git_repository *) git_reference_owner(git_reference *ref); * * @param ref The reference * @param target The new target for the reference - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_set_target(git_reference *ref, const char *target); @@ -175,7 +175,7 @@ GIT_EXTERN(int) git_reference_set_target(git_reference *ref, const char *target) * * @param ref The reference * @param id The new target OID for the reference - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_set_oid(git_reference *ref, const git_oid *id); @@ -202,7 +202,7 @@ GIT_EXTERN(int) git_reference_set_oid(git_reference *ref, const git_oid *id); * @param ref The reference to rename * @param new_name The new name for the reference * @param force Overwrite an existing reference - * @return GIT_SUCCESS or an error code + * @return 0 or an error code * */ GIT_EXTERN(int) git_reference_rename(git_reference *ref, const char *new_name, int force); @@ -216,7 +216,7 @@ GIT_EXTERN(int) git_reference_rename(git_reference *ref, const char *new_name, i * memory. The given reference pointer will no longer be valid. * * @param ref The reference to remove - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_delete(git_reference *ref); @@ -231,7 +231,7 @@ GIT_EXTERN(int) git_reference_delete(git_reference *ref); * the loose references will be removed from disk. * * @param repo Repository where the loose refs will be packed - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_packall(git_repository *repo); @@ -254,7 +254,7 @@ GIT_EXTERN(int) git_reference_packall(git_repository *repo); * @param repo Repository where to find the refs * @param list_flags Filtering flags for the reference * listing. - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_list(git_strarray *array, git_repository *repo, unsigned int list_flags); @@ -276,7 +276,7 @@ GIT_EXTERN(int) git_reference_list(git_strarray *array, git_repository *repo, un * listing. * @param callback Function which will be called for every listed ref * @param payload Additional data to pass to the callback - * @return GIT_SUCCESS or an error code + * @return 0 or an error code */ GIT_EXTERN(int) git_reference_foreach(git_repository *repo, unsigned int list_flags, int (*callback)(const char *, void *), void *payload); @@ -304,7 +304,7 @@ GIT_EXTERN(int) git_reference_is_packed(git_reference *ref); * returned and the reference pointer will be invalidated. * * @param ref The reference to reload - * @return GIT_SUCCESS on success, or an error code + * @return 0 on success, or an error code */ GIT_EXTERN(int) git_reference_reload(git_reference *ref); @@ -320,7 +320,7 @@ GIT_EXTERN(void) git_reference_free(git_reference *ref); * * @param ref1 The first git_reference * @param ref2 The second git_reference - * @return GIT_SUCCESS if the same, else a stable but meaningless ordering. + * @return 0 if the same, else a stable but meaningless ordering. */ GIT_EXTERN(int) git_reference_cmp(git_reference *ref1, git_reference *ref2); |