From a295bd2dc4a1ac2b15b9c39089d148499e6e9e00 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Mart=C3=ADn=20Nieto?= Date: Sat, 6 Dec 2014 03:36:18 +0100 Subject: doc: add documentation to all the public structs and enums 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 --- include/git2/rebase.h | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'include/git2/rebase.h') 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; -- cgit v1.2.1