summaryrefslogtreecommitdiff
path: root/include/git2/revert.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2/revert.h')
-rw-r--r--include/git2/revert.h8
1 files changed, 5 insertions, 3 deletions
diff --git a/include/git2/revert.h b/include/git2/revert.h
index 82dbadcfc..260ad044b 100644
--- a/include/git2/revert.h
+++ b/include/git2/revert.h
@@ -37,11 +37,13 @@ typedef struct {
#define GIT_REVERT_OPTIONS_INIT {GIT_REVERT_OPTIONS_VERSION, 0, GIT_MERGE_OPTIONS_INIT, GIT_CHECKOUT_OPTIONS_INIT}
/**
+ * Initialize git_revert_options structure
+ *
* Initializes a `git_revert_options` with default values. Equivalent to
- * creating an instance with GIT_REVERT_OPTIONS_INIT.
+ * creating an instance with `GIT_REVERT_OPTIONS_INIT`.
*
- * @param opts the `git_revert_options` struct to initialize
- * @param version Version of struct; pass `GIT_REVERT_OPTIONS_VERSION`
+ * @param opts The `git_revert_options` struct to initialize.
+ * @param version The struct version; pass `GIT_REVERT_OPTIONS_VERSION`.
* @return Zero on success; -1 on failure.
*/
GIT_EXTERN(int) git_revert_init_options(