diff options
author | Etienne Samson <samson.etienne@gmail.com> | 2016-11-01 17:46:20 +0100 |
---|---|---|
committer | Etienne Samson <samson.etienne@gmail.com> | 2016-11-01 17:46:20 +0100 |
commit | 8d2784d57069ddc49f99b0cde1fc3a7f83532fd9 (patch) | |
tree | 90943e71086f5779c09d37bd755a36e34e4a8ba6 /include | |
parent | a051ee31f2a3790410c2b482611f691135d2eae0 (diff) | |
download | libgit2-8d2784d57069ddc49f99b0cde1fc3a7f83532fd9.tar.gz |
describe: fix documentation
Diffstat (limited to 'include')
-rw-r--r-- | include/git2/describe.h | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/include/git2/describe.h b/include/git2/describe.h index 3044d9165..971eb350c 100644 --- a/include/git2/describe.h +++ b/include/git2/describe.h @@ -44,8 +44,8 @@ typedef enum { typedef struct git_describe_options { unsigned int version; - unsigned int max_candidates_tags; /** default: 10 */ - unsigned int describe_strategy; /** default: GIT_DESCRIBE_DEFAULT */ + unsigned int max_candidates_tags; /**< default: 10 */ + unsigned int describe_strategy; /**< default: GIT_DESCRIBE_DEFAULT */ const char *pattern; /** * When calculating the distance from the matching tag or @@ -105,6 +105,9 @@ typedef struct { GIT_EXTERN(int) git_describe_init_format_options(git_describe_format_options *opts, unsigned int version); +/** + * A struct that stores the result of a describe operation. + */ typedef struct git_describe_result git_describe_result; /** |