summaryrefslogtreecommitdiff
path: root/include/git2/status.h
diff options
context:
space:
mode:
authorDavid Boyce <boyski@users.sourceforge.net>2011-09-13 12:30:25 -0400
committerDavid Boyce <boyski@users.sourceforge.net>2011-09-13 12:30:25 -0400
commitd9111722552c3536f3663db030bb9be50bc1daff (patch)
treea8e51a65e03fa854d1e9f5df73d7a0137ea20928 /include/git2/status.h
parent3f3f6225f8237e974b135de30eaac731c929936e (diff)
downloadlibgit2-d9111722552c3536f3663db030bb9be50bc1daff.tar.gz
Standardized doxygen @return lines for int functions to say "GIT_SUCCESS or an error code".
Diffstat (limited to 'include/git2/status.h')
-rw-r--r--include/git2/status.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/status.h b/include/git2/status.h
index 7946cc1f3..fead43b02 100644
--- a/include/git2/status.h
+++ b/include/git2/status.h
@@ -60,7 +60,7 @@ GIT_BEGIN_DECL
*
* @param repo a repository object
* @param callback the function to call on each file
- * @return GIT_SUCCESS or the return value of the callback which did not return 0;
+ * @return GIT_SUCCESS or the return value of the callback which did not return GIT_SUCCESS
*/
GIT_EXTERN(int) git_status_foreach(git_repository *repo, int (*callback)(const char *, unsigned int, void *), void *payload);
@@ -70,7 +70,7 @@ GIT_EXTERN(int) git_status_foreach(git_repository *repo, int (*callback)(const c
* @param status_flags the status value
* @param repo a repository object
* @param path the file to retrieve status for, rooted at the repo's workdir
- * @return GIT_SUCCESS
+ * @return GIT_SUCCESS or an error code
*/
GIT_EXTERN(int) git_status_file(unsigned int *status_flags, git_repository *repo, const char *path);