Repository navigation
Documentation fixes - #3980
Documentation fixes#3980carlosmn merged 4 commits into
Conversation
Sorry, something went wrong.
pks-t
left a comment
There was a problem hiding this comment.
Nice findings. Looks all good besides the missing @defgroup argument.
Sorry, something went wrong.
| /** | ||
| * @file git2/transaction.h | ||
| * @brief Git transaction routines. | ||
| * @defgroup Git transaction routines. |
There was a problem hiding this comment.
This should be @defgroup git_transaction Git transaction routines instead. Please also remove the trailing dots from @brief and @defgroup.
Sorry, something went wrong.
There was a problem hiding this comment.
We don't actually use these blocks for anything with our current documentation generator, so it should just go away.
Sorry, something went wrong.
There was a problem hiding this comment.
I was trying to make docurium document those functions. Wasn't sure if the group being defined was a prerequisite, but I'll take them out then.
Sorry, something went wrong.
|
Oh, one more thing. Could you maybe clarify the commit messages a bit by prefixing them with the module they're touching primaily, please? E.g. "remote: fix indentation". Thanks for your work 👍 |
Sorry, something went wrong.
| /** | ||
| * @file git2/transaction.h | ||
| * @brief Git transaction routines. | ||
| * @defgroup Git transaction routines. |
There was a problem hiding this comment.
We don't actually use these blocks for anything with our current documentation generator, so it should just go away.
Sorry, something went wrong.
| /** | ||
| * An opaque struct that stores the result of a describe operation. | ||
| */ | ||
| typedef struct git_describe_result git_describe_result; |
There was a problem hiding this comment.
The opaqueness is not something we need to specify in the text.
Sorry, something went wrong.
There was a problem hiding this comment.
Will fix.
Sorry, something went wrong.
|
Patch series redone from scratch. docurium is giving me a hard time tough, as some things are left out of the parsing (eg. the whole of transaction.h, and things like git_branch_remote_name don't appear in the docs). Using the debug-heavy version I have here, it seems that clang sometimes misinterprets comments in some cases (eg, I get lots of :comment_null). |
Sorry, something went wrong.
Note: 8149b17 removes git_remote_rename_problem_cb. Not sure when it stopped being used though.