checkout: fix docs formatting for the options
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
diff --git a/include/git2/checkout.h b/include/git2/checkout.h
index ad44173..fe4966a 100644
--- a/include/git2/checkout.h
+++ b/include/git2/checkout.h
@@ -233,18 +233,18 @@ typedef void (*git_checkout_progress_cb)(
typedef struct git_checkout_options {
unsigned int version;
- unsigned int checkout_strategy; /** default will be a dry run */
+ unsigned int checkout_strategy; /**< default will be a dry run */
- int disable_filters; /** don't apply filters like CRLF conversion */
- unsigned int dir_mode; /** default is 0755 */
- unsigned int file_mode; /** default is 0644 or 0755 as dictated by blob */
- int file_open_flags; /** default is O_CREAT | O_TRUNC | O_WRONLY */
+ int disable_filters; /**< don't apply filters like CRLF conversion */
+ unsigned int dir_mode; /**< default is 0755 */
+ unsigned int file_mode; /**< default is 0644 or 0755 as dictated by blob */
+ int file_open_flags; /**< default is O_CREAT | O_TRUNC | O_WRONLY */
- unsigned int notify_flags; /** see `git_checkout_notify_t` above */
+ unsigned int notify_flags; /**< see `git_checkout_notify_t` above */
git_checkout_notify_cb notify_cb;
void *notify_payload;
- /* Optional callback to notify the consumer of checkout progress. */
+ /** Optional callback to notify the consumer of checkout progress. */
git_checkout_progress_cb progress_cb;
void *progress_payload;
@@ -254,13 +254,13 @@ typedef struct git_checkout_options {
*/
git_strarray paths;
- git_tree *baseline; /** expected content of workdir, defaults to HEAD */
+ git_tree *baseline; /**< expected content of workdir, defaults to HEAD */
- const char *target_directory; /** alternative checkout path to workdir */
+ const char *target_directory; /**< alternative checkout path to workdir */
- const char *ancestor_label; /** the name of the common ancestor side of conflicts */
- const char *our_label; /** the name of the "our" side of conflicts */
- const char *their_label; /** the name of the "their" side of conflicts */
+ const char *ancestor_label; /**< the name of the common ancestor side of conflicts */
+ const char *our_label; /**< the name of the "our" side of conflicts */
+ const char *their_label; /**< the name of the "their" side of conflicts */
} git_checkout_options;
#define GIT_CHECKOUT_OPTIONS_VERSION 1