summaryrefslogtreecommitdiff
path: root/include/git2/remote.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/remote.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/remote.h')
-rw-r--r--include/git2/remote.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/remote.h b/include/git2/remote.h
index 651e41075..63908e1f2 100644
--- a/include/git2/remote.h
+++ b/include/git2/remote.h
@@ -53,7 +53,7 @@ GIT_BEGIN_DECL
* @param out pointer to the new remote object
* @param repo the associtated repository
* @param url the remote repository's URL
- * @return GIT_SUCCESS or an error message
+ * @return GIT_SUCCESS or an error code
*/
int git_remote_new(git_remote **out, git_repository *repo, const char *url);
@@ -63,7 +63,7 @@ int git_remote_new(git_remote **out, git_repository *repo, const char *url);
* @param out pointer to the new remote object
* @param cfg the repository's configuration
* @param name the remote's name
- * @return 0 on success; error value otherwise
+ * @return GIT_SUCCESS or an error code
*/
GIT_EXTERN(int) git_remote_get(struct git_remote **out, struct git_config *cfg, const char *name);