Skip to content

Conversation

rcjsuen
Copy link
Contributor

@rcjsuen rcjsuen commented Mar 21, 2017

If you look at the documentation for git_cred_acquire_cb, you will see that the format is completely off with everything at the bottom with its return value and parameters undocumented. Compare this with git_diff_progress_cb where its parameters and return value is correctly documented because of its proper use of tags in the header file.

The documentation for git_cred_acquire_cb should be using standard @param and @return tags so that the documentation will be generated correctly.

git_cred_acquire_cb isn't using the standard @param and @return tags.
This is causing the generated documentation to not be formatted
properly.
@ethomson
Copy link
Member

Thanks!

@ethomson ethomson merged commit 69d0b46 into libgit2:master Mar 22, 2017
@rcjsuen rcjsuen deleted the patch-1 branch March 24, 2017 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants