diff options
author | David Boyce <boyski@users.sourceforge.net> | 2011-09-13 12:30:25 -0400 |
---|---|---|
committer | David Boyce <boyski@users.sourceforge.net> | 2011-09-13 12:30:25 -0400 |
commit | d9111722552c3536f3663db030bb9be50bc1daff (patch) | |
tree | a8e51a65e03fa854d1e9f5df73d7a0137ea20928 /include/git2/revwalk.h | |
parent | 3f3f6225f8237e974b135de30eaac731c929936e (diff) | |
download | libgit2-d9111722552c3536f3663db030bb9be50bc1daff.tar.gz |
Standardized doxygen @return lines for int functions to say "GIT_SUCCESS or an error code".
Diffstat (limited to 'include/git2/revwalk.h')
-rw-r--r-- | include/git2/revwalk.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h index b37a16c83..8d045333b 100644 --- a/include/git2/revwalk.h +++ b/include/git2/revwalk.h @@ -83,7 +83,7 @@ GIT_BEGIN_DECL * * @param walker pointer to the new revision walker * @param repo the repo to walk through - * @return 0 on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_revwalk_new(git_revwalk **walker, git_repository *repo); @@ -115,7 +115,7 @@ GIT_EXTERN(void) git_revwalk_reset(git_revwalk *walker); * * @param walk the walker being used for the traversal. * @param oid the oid of the commit to start from. - * @return 0 on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *oid); @@ -131,7 +131,7 @@ GIT_EXTERN(int) git_revwalk_push(git_revwalk *walk, const git_oid *oid); * * @param walk the walker being used for the traversal. * @param oid the oid of commit that will be ignored during the traversal - * @return 0 on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_revwalk_hide(git_revwalk *walk, const git_oid *oid); |