summaryrefslogtreecommitdiff
path: root/include/git2/rebase.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/git2/rebase.h')
-rw-r--r--include/git2/rebase.h9
1 files changed, 5 insertions, 4 deletions
diff --git a/include/git2/rebase.h b/include/git2/rebase.h
index 3aefe2643..f6b2e20ad 100644
--- a/include/git2/rebase.h
+++ b/include/git2/rebase.h
@@ -147,12 +147,13 @@ typedef struct {
} git_rebase_operation;
/**
+ * Initialize git_rebase_options structure
+ *
* Initializes a `git_rebase_options` with default values. Equivalent to
- * creating an instance with GIT_REBASE_OPTIONS_INIT.
+ * creating an instance with `GIT_REBASE_OPTIONS_INIT`.
*
- * @param opts the `git_rebase_options` instance to initialize.
- * @param version the version of the struct; you should pass
- * `GIT_REBASE_OPTIONS_VERSION` here.
+ * @param opts The `git_rebase_options` struct to initialize.
+ * @param version The struct version; pass `GIT_REBASE_OPTIONS_VERSION`.
* @return Zero on success; -1 on failure.
*/
GIT_EXTERN(int) git_rebase_init_options(