diff options
author | Remy Suen <remy.suen@gmail.com> | 2017-03-22 06:08:24 +0900 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-03-22 06:08:24 +0900 |
commit | 84b4e5733d734ac4459207f768acaab9d7fd6b5e (patch) | |
tree | 32ab56f2e77dcd3ab5c62aa77a83f820c7a7c283 /include | |
parent | 33ea4aae378f390aa4e2163389cd2cc183420ebe (diff) | |
download | libgit2-84b4e5733d734ac4459207f768acaab9d7fd6b5e.tar.gz |
Use proper documentation tags
git_cred_acquire_cb isn't using the standard @param and @return tags.
This is causing the generated documentation to not be formatted
properly.
Diffstat (limited to 'include')
-rw-r--r-- | include/git2/transport.h | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/include/git2/transport.h b/include/git2/transport.h index 0ec241699..0c371bf4b 100644 --- a/include/git2/transport.h +++ b/include/git2/transport.h @@ -321,13 +321,13 @@ GIT_EXTERN(void) git_cred_free(git_cred *cred); /** * Signature of a function which acquires a credential object. * - * - cred: The newly created credential object. - * - url: The resource for which we are demanding a credential. - * - username_from_url: The username that was embedded in a "user\@host" + * @param cred The newly created credential object. + * @param url The resource for which we are demanding a credential. + * @param username_from_url The username that was embedded in a "user\@host" * remote url, or NULL if not included. - * - allowed_types: A bitmask stating which cred types are OK to return. - * - payload: The payload provided when specifying this callback. - * - returns 0 for success, < 0 to indicate an error, > 0 to indicate + * @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, < 0 to indicate an error, > 0 to indicate * no credential was acquired */ typedef int (*git_cred_acquire_cb)( |