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/stash.h | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'include/git2/stash.h') diff --git a/include/git2/stash.h b/include/git2/stash.h index e2fe2cf0b..280c647e8 100644 --- a/include/git2/stash.h +++ b/include/git2/stash.h @@ -18,21 +18,30 @@ */ GIT_BEGIN_DECL +/** + * Stash flags + */ typedef enum { + /** + * No option, default + */ GIT_STASH_DEFAULT = 0, - /* All changes already added to the index - * are left intact in the working directory + /** + * All changes already added to the index are left intact in + * the working directory */ GIT_STASH_KEEP_INDEX = (1 << 0), - /* All untracked files are also stashed and then - * cleaned up from the working directory + /** + * All untracked files are also stashed and then cleaned up + * from the working directory */ GIT_STASH_INCLUDE_UNTRACKED = (1 << 1), - /* All ignored files are also stashed and then - * cleaned up from the working directory + /** + * All ignored files are also stashed and then cleaned up from + * the working directory */ GIT_STASH_INCLUDE_IGNORED = (1 << 2), } git_stash_flags; -- cgit v1.2.1