Skip to content

G
git2
Commit 4b45675d by Vicent Martí
Options

Merge pull request #1248 from sba1/doc-fix 

Some doc improvements in transport.h
parents 365485e3 62d4fa23
Showing with 3 additions and 0 deletions
include/git2/transport.h
...@@ -45,10 +45,12 @@ typedef struct git_cred_userpass_plaintext { ...@@ -45,10 +45,12 @@ typedef struct git_cred_userpass_plaintext {
/** /**
* Creates a new plain-text username and password credential object. * 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 out The newly created credential object.
* @param username The username of the credential. * @param username The username of the credential.
* @param password The password 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_EXTERN(int) git_cred_userpass_plaintext_new(
git_cred **out, git_cred **out,
...@@ -62,6 +64,7 @@ GIT_EXTERN(int) git_cred_userpass_plaintext_new( ...@@ -62,6 +64,7 @@ GIT_EXTERN(int) git_cred_userpass_plaintext_new(
* @param url The resource for which we are demanding a credential. * @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 allowed_types A bitmask stating which cred types are OK to return.
* @param payload The payload provided when specifying this callback. * @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)( typedef int (*git_cred_acquire_cb)(
git_cred **cred, git_cred **cred,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment