diff options
author | Carlos Martín Nieto <cmn@dwim.me> | 2014-12-06 03:36:18 +0100 |
---|---|---|
committer | Carlos Martín Nieto <cmn@dwim.me> | 2014-12-06 03:44:40 +0100 |
commit | a295bd2dc4a1ac2b15b9c39089d148499e6e9e00 (patch) | |
tree | e9d3a1bffdaf0a3469943956f32a06d507c8dcf0 /include/git2/stash.h | |
parent | d43c7bd050cd461b13f4b5aa30f14010c5b2b611 (diff) | |
download | libgit2-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/stash.h')
-rw-r--r-- | include/git2/stash.h | 21 |
1 files changed, 15 insertions, 6 deletions
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; |