summaryrefslogtreecommitdiff
path: root/include/git2/merge.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/merge.h
parentd43c7bd050cd461b13f4b5aa30f14010c5b2b611 (diff)
downloadlibgit2-a295bd2dc4a1ac2b15b9c39089d148499e6e9e00.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/merge.h')
-rw-r--r--include/git2/merge.h25
1 files changed, 20 insertions, 5 deletions
diff --git a/include/git2/merge.h b/include/git2/merge.h
index fb06d6e37..09900f12b 100644
--- a/include/git2/merge.h
+++ b/include/git2/merge.h
@@ -110,20 +110,26 @@ typedef enum {
GIT_MERGE_FILE_FAVOR_UNION = 3,
} git_merge_file_favor_t;
+/**
+ * File merging flags
+ */
typedef enum {
- /* Defaults */
+ /** Defaults */
GIT_MERGE_FILE_DEFAULT = 0,
- /* Create standard conflicted merge files */
+ /** Create standard conflicted merge files */
GIT_MERGE_FILE_STYLE_MERGE = (1 << 0),
- /* Create diff3-style files */
+ /** Create diff3-style files */
GIT_MERGE_FILE_STYLE_DIFF3 = (1 << 1),
- /* Condense non-alphanumeric regions for simplified diff file */
+ /** Condense non-alphanumeric regions for simplified diff file */
GIT_MERGE_FILE_SIMPLIFY_ALNUM = (1 << 2),
} git_merge_file_flags_t;
+/**
+ * Options for merging a file
+ */
typedef struct {
unsigned int version;
@@ -168,6 +174,9 @@ GIT_EXTERN(int) git_merge_file_init_options(
git_merge_file_options *opts,
unsigned int version);
+/**
+ * Information about file-level merging
+ */
typedef struct {
/**
* True if the output was automerged, false if the output contains
@@ -191,6 +200,9 @@ typedef struct {
size_t len;
} git_merge_file_result;
+/**
+ * Merging options
+ */
typedef struct {
unsigned int version;
git_merge_tree_flag_t flags;
@@ -270,8 +282,11 @@ typedef enum {
GIT_MERGE_ANALYSIS_UNBORN = (1 << 3),
} git_merge_analysis_t;
+/**
+ * The user's stated preference for merges.
+ */
typedef enum {
- /*
+ /**
* No configuration was found that suggests a preferred behavior for
* merge.
*/