Skip to content

Commit 8d2784d

Browse files
committed
describe: fix documentation
1 parent a051ee3 commit 8d2784d

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

include/git2/describe.h

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ typedef enum {
4444
typedef struct git_describe_options {
4545
unsigned int version;
4646

47-
unsigned int max_candidates_tags; /** default: 10 */
48-
unsigned int describe_strategy; /** default: GIT_DESCRIBE_DEFAULT */
47+
unsigned int max_candidates_tags; /**< default: 10 */
48+
unsigned int describe_strategy; /**< default: GIT_DESCRIBE_DEFAULT */
4949
const char *pattern;
5050
/**
5151
* When calculating the distance from the matching tag or
@@ -105,6 +105,9 @@ typedef struct {
105105

106106
GIT_EXTERN(int) git_describe_init_format_options(git_describe_format_options *opts, unsigned int version);
107107

108+
/**
109+
* A struct that stores the result of a describe operation.
110+
*/
108111
typedef struct git_describe_result git_describe_result;
109112

110113
/**

0 commit comments

Comments
 (0)