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/signature.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/signature.h')
-rw-r--r-- | include/git2/signature.h | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/signature.h b/include/git2/signature.h index f5d03ac77..d2d3e25be 100644 --- a/include/git2/signature.h +++ b/include/git2/signature.h @@ -46,7 +46,7 @@ GIT_BEGIN_DECL * @param email email of the person * @param time time when the action happened * @param offset timezone offset in minutes for the time - * @return 0 on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_signature_new(git_signature **sig_out, const char *name, const char *email, git_time_t time, int offset); @@ -57,7 +57,7 @@ GIT_EXTERN(int) git_signature_new(git_signature **sig_out, const char *name, con * @param sig_out new signature, in case of error NULL * @param name name of the person * @param email email of the person - * @return 0 on success; error code otherwise + * @return GIT_SUCCESS or an error code */ GIT_EXTERN(int) git_signature_now(git_signature **sig_out, const char *name, const char *email); |