summaryrefslogtreecommitdiff
path: root/include/git2/cherrypick.h
diff options
context:
space:
mode:
authorCarlos Martín Nieto <cmn@dwim.me>2014-12-06 03:36:18 +0100
committerCarlos Martín Nieto <cmn@dwim.me>2014-12-06 03:44:40 +0100
commita295bd2dc4a1ac2b15b9c39089d148499e6e9e00 (patch)
treee9d3a1bffdaf0a3469943956f32a06d507c8dcf0 /include/git2/cherrypick.h
parentd43c7bd050cd461b13f4b5aa30f14010c5b2b611 (diff)
downloadlibgit2-cmn/doc-all.tar.gz
doc: add documentation to all the public structs and enumscmn/doc-all
This makes them show up in the reference, even if the text itself isn't the most descriptive. These have been found with grep -Przon '\n\ntypedef struct.*?\{' -- include grep -Przon '\n\ntypedef enum.*?\{' -- include
Diffstat (limited to 'include/git2/cherrypick.h')
-rw-r--r--include/git2/cherrypick.h7
1 files changed, 5 insertions, 2 deletions
diff --git a/include/git2/cherrypick.h b/include/git2/cherrypick.h
index dea67c1ff..208166c19 100644
--- a/include/git2/cherrypick.h
+++ b/include/git2/cherrypick.h
@@ -20,14 +20,17 @@
*/
GIT_BEGIN_DECL
+/**
+ * Cherry-pick options
+ */
typedef struct {
unsigned int version;
/** For merge commits, the "mainline" is treated as the parent. */
unsigned int mainline;
- git_merge_options merge_opts;
- git_checkout_options checkout_opts;
+ git_merge_options merge_opts; /*< Options for the merging */
+ git_checkout_options checkout_opts; /*< Options for the checkout */
} git_cherrypick_options;
#define GIT_CHERRYPICK_OPTIONS_VERSION 1