Skip to content

G
git2
Commit 8d2784d5 by Etienne Samson
Options

describe: fix documentation

parent a051ee31
Showing with 5 additions and 2 deletions
include/git2/describe.h
...@@ -44,8 +44,8 @@ typedef enum { ...@@ -44,8 +44,8 @@ typedef enum {
typedef struct git_describe_options { typedef struct git_describe_options {
unsigned int version; unsigned int version;
unsigned int max_candidates_tags; /** default: 10 */ unsigned int max_candidates_tags; /**< default: 10 */
unsigned int describe_strategy; /** default: GIT_DESCRIBE_DEFAULT */ unsigned int describe_strategy; /**< default: GIT_DESCRIBE_DEFAULT */
const char *pattern; const char *pattern;
/** /**
* When calculating the distance from the matching tag or * When calculating the distance from the matching tag or
...@@ -105,6 +105,9 @@ typedef struct { ...@@ -105,6 +105,9 @@ typedef struct {
GIT_EXTERN(int) git_describe_init_format_options(git_describe_format_options *opts, unsigned int version); 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; typedef struct git_describe_result git_describe_result;
/** /**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment