summaryrefslogtreecommitdiff
path: root/include/git2/rebase.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/rebase.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/rebase.h')
-rw-r--r--include/git2/rebase.h15
1 files changed, 14 insertions, 1 deletions
diff --git a/include/git2/rebase.h b/include/git2/rebase.h
index 095975edb..192465036 100644
--- a/include/git2/rebase.h
+++ b/include/git2/rebase.h
@@ -21,6 +21,11 @@
*/
GIT_BEGIN_DECL
+/**
+ * Rebase options
+ *
+ * Use to tell the rebase machinery how to operate.
+ */
typedef struct {
unsigned int version;
@@ -40,7 +45,9 @@ typedef struct {
const char *rewrite_notes_ref;
} git_rebase_options;
-/** Type of rebase operation in-progress after calling `git_rebase_next`. */
+/**
+ * Type of rebase operation in-progress after calling `git_rebase_next`.
+ */
typedef enum {
/**
* The given commit is to be cherry-picked. The client should commit
@@ -82,6 +89,12 @@ typedef enum {
#define GIT_REBASE_OPTIONS_VERSION 1
#define GIT_REBASE_OPTIONS_INIT {GIT_REBASE_OPTIONS_VERSION}
+/**
+ * A rebase operation
+ *
+ * Describes a single instruction/operation to be performed during the
+ * rebase.
+ */
typedef struct {
/** The type of rebase operation. */
git_rebase_operation_t type;