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/worktree.h | |
| parent | c7b42f44a26ecbaf08aaa209df8a7d5941c01c0a (diff) | |
| download | libgit2-04c48afc3c2f3413883afee70ea748374e0a2293.tar.gz | |
docs: standardize struct git_*_options comments
Diffstat (limited to 'include/git2/worktree.h')
| -rw-r--r-- | include/git2/worktree.h | 10 |
1 files changed, 4 insertions, 6 deletions
diff --git a/include/git2/worktree.h b/include/git2/worktree.h index fa4b57802..d1b4f84c2 100644 --- a/include/git2/worktree.h +++ b/include/git2/worktree.h @@ -77,10 +77,9 @@ GIT_EXTERN(int) git_worktree_validate(const git_worktree *wt); /** * Worktree add options structure * - * Zero out for defaults. Initialize with `GIT_WORKTREE_ADD_OPTIONS_INIT` - * macro to correctly set the `version` field. E.g. + * Initialize with `GIT_WORKTREE_ADD_OPTIONS_INIT`. Alternatively, you can + * use `git_worktree_add_init_options`. * - * git_worktree_add_options opts = GIT_WORKTREE_ADD_OPTIONS_INIT; */ typedef struct git_worktree_add_options { unsigned int version; @@ -192,10 +191,9 @@ typedef enum { /** * Worktree prune options structure * - * Zero out for defaults. Initialize with `GIT_WORKTREE_PRUNE_OPTIONS_INIT` - * macro to correctly set the `version` field. E.g. + * Initialize with `GIT_WORKTREE_PRUNE_OPTIONS_INIT`. Alternatively, you can + * use `git_worktree_prune_init_options`. * - * git_worktree_prune_options opts = GIT_WORKTREE_PRUNE_OPTIONS_INIT; */ typedef struct git_worktree_prune_options { unsigned int version; |
