New upstream version 1.1.0+dfsg.1

[libgit2.git] / include / git2 / revert.h

diff --git a/include/git2/revert.h b/include/git2/revert.h
index eb069ae12765c5d3309b9d3db3e1cf40d2f377d5..331e90dffcf5047b0529a4863313e5695ec83c3b 100644 (file)
--- a/include/git2/revert.h
+++ b/include/git2/revert.h
@@ -29,22 +29,24 @@ typedef struct {
        /** For merge commits, the "mainline" is treated as the parent. */
        unsigned int mainline;
 
-       git_merge_options merge_opts; /* Options for the merging */
-       git_checkout_options checkout_opts; /* Options for the checkout */
+       git_merge_options merge_opts; /**< Options for the merging */
+       git_checkout_options checkout_opts; /**< Options for the checkout */
 } git_revert_options;
 
 #define GIT_REVERT_OPTIONS_VERSION 1
 #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(
+GIT_EXTERN(int) git_revert_options_init(
        git_revert_options *opts,
        unsigned int version);
 
@@ -75,7 +77,7 @@ GIT_EXTERN(int) git_revert_commit(
  *
  * @param repo the repository to revert
  * @param commit the commit to revert
- * @param given_opts merge flags
+ * @param given_opts the revert options (or null for defaults)
  * @return zero on success, -1 on failure.
  */
 GIT_EXTERN(int) git_revert(