Skip to content

Commit 69d0b46

Browse files
authored
Merge pull request libgit2#4172 from rcjsuen/patch-1
Fix the documentation for git_cred_acquire_cb
2 parents 33ea4aa + 84b4e57 commit 69d0b46

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

include/git2/transport.h

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -321,13 +321,13 @@ GIT_EXTERN(void) git_cred_free(git_cred *cred);
321321
/**
322322
* Signature of a function which acquires a credential object.
323323
*
324-
* - cred: The newly created credential object.
325-
* - url: The resource for which we are demanding a credential.
326-
* - username_from_url: The username that was embedded in a "user\@host"
324+
* @param cred The newly created credential object.
325+
* @param url The resource for which we are demanding a credential.
326+
* @param username_from_url The username that was embedded in a "user\@host"
327327
* remote url, or NULL if not included.
328-
* - allowed_types: A bitmask stating which cred types are OK to return.
329-
* - payload: The payload provided when specifying this callback.
330-
* - returns 0 for success, < 0 to indicate an error, > 0 to indicate
328+
* @param allowed_types A bitmask stating which cred types are OK to return.
329+
* @param payload The payload provided when specifying this callback.
330+
* @return 0 for success, < 0 to indicate an error, > 0 to indicate
331331
* no credential was acquired
332332
*/
333333
typedef int (*git_cred_acquire_cb)(

0 commit comments

Comments
 (0)