diff options
| author | Etienne Samson <samson.etienne@gmail.com> | 2018-04-20 21:07:17 +0000 |
|---|---|---|
| committer | Etienne Samson <samson.etienne@gmail.com> | 2018-05-07 21:50:38 +0200 |
| commit | 04c48afc3c2f3413883afee70ea748374e0a2293 (patch) | |
| tree | f01432c236fe1aa2217b01e841a1cc12211147a5 /include/git2/checkout.h | |
| parent | c7b42f44a26ecbaf08aaa209df8a7d5941c01c0a (diff) | |
| download | libgit2-04c48afc3c2f3413883afee70ea748374e0a2293.tar.gz | |
docs: standardize struct git_*_options comments
Diffstat (limited to 'include/git2/checkout.h')
| -rw-r--r-- | include/git2/checkout.h | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/include/git2/checkout.h b/include/git2/checkout.h index 9a1cdfbdd..7ba0df871 100644 --- a/include/git2/checkout.h +++ b/include/git2/checkout.h @@ -243,10 +243,9 @@ typedef void (*git_checkout_perfdata_cb)( /** * Checkout options structure * - * Zero out for defaults. Initialize with `GIT_CHECKOUT_OPTIONS_INIT` macro to - * correctly set the `version` field. E.g. + * Initialize with `GIT_CHECKOUT_OPTIONS_INIT`. Alternatively, you can + * use `git_checkout_init_options`. * - * git_checkout_options opts = GIT_CHECKOUT_OPTIONS_INIT; */ typedef struct git_checkout_options { unsigned int version; |