diff options
author | Ben Straub <bs@github.com> | 2012-11-27 14:03:53 -0800 |
---|---|---|
committer | Ben Straub <bs@github.com> | 2012-11-27 14:03:53 -0800 |
commit | ff6b5ac97d0cae2088c45b691002934e2920e872 (patch) | |
tree | d8bcb01e45c012eb40583c569e230b76300192bf /include/git2/signature.h | |
parent | 44d9f2cb60f05c05ab55e6aaae0fda8b31bbbbc6 (diff) | |
download | libgit2-ff6b5ac97d0cae2088c45b691002934e2920e872.tar.gz |
API updates for signature.h
Diffstat (limited to 'include/git2/signature.h')
-rw-r--r-- | include/git2/signature.h | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/include/git2/signature.h b/include/git2/signature.h index cdbe67879..01a6dfb44 100644 --- a/include/git2/signature.h +++ b/include/git2/signature.h @@ -26,31 +26,32 @@ GIT_BEGIN_DECL * Note: angle brackets ('<' and '>') characters are not allowed * to be used in either the `name` or the `email` parameter. * - * @param sig_out new signature, in case of error NULL + * @param out new signature, in case of error NULL * @param name name of the person * @param email email of the person * @param time time when the action happened * @param offset timezone offset in minutes for the time * @return 0 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); +GIT_EXTERN(int) git_signature_new(git_signature **out, const char *name, const char *email, git_time_t time, int offset); /** * Create a new action signature with a timestamp of 'now'. The * signature must be freed manually or using git_signature_free * - * @param sig_out new signature, in case of error NULL + * @param out new signature, in case of error NULL * @param name name of the person * @param email email of the person * @return 0 or an error code */ -GIT_EXTERN(int) git_signature_now(git_signature **sig_out, const char *name, const char *email); +GIT_EXTERN(int) git_signature_now(git_signature **out, const char *name, const char *email); /** - * Create a copy of an existing signature. + * Create a copy of an existing signature. All internal strings are also duplicated. + * The caller is responsible for freeing this structure with + * git_signature_free. * - * All internal strings are also duplicated. * @param sig signature to duplicated * @return a copy of sig, NULL on out of memory */ |