diff options
| author | Etienne Samson <samson.etienne@gmail.com> | 2018-03-22 23:27:27 +0100 |
|---|---|---|
| committer | Etienne Samson <samson.etienne@gmail.com> | 2018-05-07 21:50:38 +0200 |
| commit | ca5a15e51b361691087c92eb391411607d867f4b (patch) | |
| tree | 5eade0d0f711ec5418798f925294f42d5f8f6bb4 /include/git2/clone.h | |
| parent | 8ee183a2daa6695ec1e240a5d23626d63f9e7cf5 (diff) | |
| download | libgit2-ca5a15e51b361691087c92eb391411607d867f4b.tar.gz | |
docs: standardize comment block for git_*_init_options functions
Diffstat (limited to 'include/git2/clone.h')
| -rw-r--r-- | include/git2/clone.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/include/git2/clone.h b/include/git2/clone.h index 9e23aaccb..29a229bb8 100644 --- a/include/git2/clone.h +++ b/include/git2/clone.h @@ -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( |