diff options
| author | Vicent Martà <vicent@github.com> | 2013-01-16 14:20:41 -0800 |
|---|---|---|
| committer | Vicent Martà <vicent@github.com> | 2013-01-16 14:20:41 -0800 |
| commit | 4b45675d7c014719cf5d46870f6d369eb08d0b1c (patch) | |
| tree | b25be4531f8e8b2a9f50b0e70ae7c83fe187fc16 | |
| parent | 365485e3c6d3abb780e9f7aff8b7af2d7be7af0b (diff) | |
| parent | 62d4fa23a8ed1e00cbb359d50bd090a88a89781d (diff) | |
| download | libgit2-4b45675d7c014719cf5d46870f6d369eb08d0b1c.tar.gz | |
Merge pull request #1248 from sba1/doc-fix
Some doc improvements in transport.h
| -rw-r--r-- | include/git2/transport.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/git2/transport.h b/include/git2/transport.h index 1aa87cabe..4945ff151 100644 --- a/include/git2/transport.h +++ b/include/git2/transport.h @@ -45,10 +45,12 @@ typedef struct git_cred_userpass_plaintext { /** * Creates a new plain-text username and password credential object. + * The supplied credential parameter will be internally duplicated. * * @param out The newly created credential object. * @param username The username of the credential. * @param password The password of the credential. + * @return 0 for success or an error code for failure */ GIT_EXTERN(int) git_cred_userpass_plaintext_new( git_cred **out, @@ -62,6 +64,7 @@ GIT_EXTERN(int) git_cred_userpass_plaintext_new( * @param url The resource for which we are demanding a credential. * @param allowed_types A bitmask stating which cred types are OK to return. * @param payload The payload provided when specifying this callback. + * @return 0 for success or an error code for failure */ typedef int (*git_cred_acquire_cb)( git_cred **cred, |