diff options
| author | Sebastian Bauer <mail@sebastianbauer.info> | 2013-01-16 12:25:28 +0100 |
|---|---|---|
| committer | Sebastian Bauer <mail@sebastianbauer.info> | 2013-01-16 12:25:28 +0100 |
| commit | 62d4fa23a8ed1e00cbb359d50bd090a88a89781d (patch) | |
| tree | c322d2ae9aa08c844ddce33597a2a89d10b4538f /include/git2/transport.h | |
| parent | 848d77dc8314895d6ad1a9b36f30a36fc505e230 (diff) | |
| download | libgit2-62d4fa23a8ed1e00cbb359d50bd090a88a89781d.tar.gz | |
Some doc improvements
Diffstat (limited to 'include/git2/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, |