Commit 4b45675d7c014719cf5d46870f6d369eb08d0b1c

Vicent Martí 2013-01-16T14:20:41

Merge pull request #1248 from sba1/doc-fix Some doc improvements in transport.h

diff --git a/include/git2/transport.h b/include/git2/transport.h
index 1aa87ca..4945ff1 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,