diff options
Diffstat (limited to 'include/git2/index.h')
-rw-r--r-- | include/git2/index.h | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/include/git2/index.h b/include/git2/index.h index 18ab9b858..36274b4a9 100644 --- a/include/git2/index.h +++ b/include/git2/index.h @@ -124,7 +124,7 @@ typedef struct git_index_entry_unmerged { * * @param index the pointer for the new index * @param index_path the path to the index file in disk - * @return 0 on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_index_open(git_index **index, const char *index_path); @@ -149,7 +149,7 @@ GIT_EXTERN(void) git_index_free(git_index *index); * by reading from the hard disk. * * @param index an existing index object - * @return 0 on success, otherwise an error code + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_index_read(git_index *index); @@ -158,7 +158,7 @@ GIT_EXTERN(int) git_index_read(git_index *index); * using an atomic file lock. * * @param index an existing index object - * @return 0 on success, otherwise an error code + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_index_write(git_index *index); @@ -190,7 +190,7 @@ GIT_EXTERN(void) git_index_uniq(git_index *index); * @param index an existing index object * @param path filename to add * @param stage stage for the entry - * @return 0 on success, otherwise an error code + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_index_add(git_index *index, const char *path, int stage); @@ -202,7 +202,7 @@ GIT_EXTERN(int) git_index_add(git_index *index, const char *path, int stage); * * @param index an existing index object * @param source_entry new entry object - * @return 0 on success, otherwise an error code + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_index_add2(git_index *index, const git_index_entry *source_entry); @@ -221,7 +221,7 @@ GIT_EXTERN(int) git_index_add2(git_index *index, const git_index_entry *source_e * @param index an existing index object * @param path filename to add * @param stage stage for the entry - * @return 0 on success, otherwise an error code + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_index_append(git_index *index, const char *path, int stage); @@ -238,7 +238,7 @@ GIT_EXTERN(int) git_index_append(git_index *index, const char *path, int stage); * * @param index an existing index object * @param source_entry new entry object - * @return 0 on success, otherwise an error code + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_index_append2(git_index *index, const git_index_entry *source_entry); @@ -247,7 +247,7 @@ GIT_EXTERN(int) git_index_append2(git_index *index, const git_index_entry *sourc * * @param index an existing index object * @param position position of the entry to remove - * @return 0 on success, otherwise an error code + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_index_remove(git_index *index, int position); |