diff options
| author | Carlos Martín Nieto <cmn@dwim.me> | 2014-10-17 22:22:59 +0200 |
|---|---|---|
| committer | Carlos Martín Nieto <cmn@dwim.me> | 2014-10-18 15:22:19 +0200 |
| commit | 12e1803188407e6ee18b9bd22186dd5d02c8ba78 (patch) | |
| tree | 496b54f10f56faa0588bcdebfd6d579f343b90c0 /include/git2/revwalk.h | |
| parent | c51aa74ed38c2b8b86d5dbd2c8e58e45975db38a (diff) | |
| download | libgit2-12e1803188407e6ee18b9bd22186dd5d02c8ba78.tar.gz | |
Update some documentation
Diffstat (limited to 'include/git2/revwalk.h')
| -rw-r--r-- | include/git2/revwalk.h | 51 |
1 files changed, 28 insertions, 23 deletions
diff --git a/include/git2/revwalk.h b/include/git2/revwalk.h index 1bd6186f3..0a5fdce21 100644 --- a/include/git2/revwalk.h +++ b/include/git2/revwalk.h @@ -21,33 +21,38 @@ GIT_BEGIN_DECL /** - * Sort the repository contents in no particular ordering; - * this sorting is arbitrary, implementation-specific - * and subject to change at any time. - * This is the default sorting for new walkers. + * Flags to specify the sorting which a revwalk should perform. */ -#define GIT_SORT_NONE (0) +typedef enum { + /** + * Sort the repository contents in no particular ordering; + * this sorting is arbitrary, implementation-specific + * and subject to change at any time. + * This is the default sorting for new walkers. + */ + GIT_SORT_NONE = 0, -/** - * Sort the repository contents in topological order - * (parents before children); this sorting mode - * can be combined with time sorting. - */ -#define GIT_SORT_TOPOLOGICAL (1 << 0) + /** + * Sort the repository contents in topological order + * (parents before children); this sorting mode + * can be combined with time sorting. + */ + GIT_SORT_TOPOLOGICAL = 1 << 0, -/** - * Sort the repository contents by commit time; - * this sorting mode can be combined with - * topological sorting. - */ -#define GIT_SORT_TIME (1 << 1) + /** + * Sort the repository contents by commit time; + * this sorting mode can be combined with + * topological sorting. + */ + GIT_SORT_TIME = 1 << 1, -/** - * Iterate through the repository contents in reverse - * order; this sorting mode can be combined with - * any of the above. - */ -#define GIT_SORT_REVERSE (1 << 2) + /** + * Iterate through the repository contents in reverse + * order; this sorting mode can be combined with + * any of the above. + */ + GIT_SORT_REVERSE = 1 << 2, +} git_sort_t; /** * Allocate a new revision walker to iterate through a repo. |
