diff options
Diffstat (limited to 'include/git2/clone.h')
| -rw-r--r-- | include/git2/clone.h | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/include/git2/clone.h b/include/git2/clone.h index 9e23aaccb..469031700 100644 --- a/include/git2/clone.h +++ b/include/git2/clone.h @@ -96,9 +96,9 @@ typedef int (*git_repository_create_cb)( /** * Clone options structure * - * Use the GIT_CLONE_OPTIONS_INIT to get the default settings, like this: + * Initialize with `GIT_CLONE_OPTIONS_INIT`. Alternatively, you can + * use `git_clone_init_options`. * - * git_clone_options opts = GIT_CLONE_OPTIONS_INIT; */ typedef struct git_clone_options { unsigned int version; @@ -169,11 +169,13 @@ typedef struct git_clone_options { GIT_FETCH_OPTIONS_INIT } /** - * Initializes a `git_clone_options` with default values. Equivalent to - * creating an instance with GIT_CLONE_OPTIONS_INIT. + * Initialize git_clone_options structure * - * @param opts The `git_clone_options` struct to initialize - * @param version Version of struct; pass `GIT_CLONE_OPTIONS_VERSION` + * Initializes a `git_clone_options` with default values. Equivalent to creating + * an instance with GIT_CLONE_OPTIONS_INIT. + * + * @param opts The `git_clone_options` struct to initialize. + * @param version The struct version; pass `GIT_CLONE_OPTIONS_VERSION`. * @return Zero on success; -1 on failure. */ GIT_EXTERN(int) git_clone_init_options( |