diff options
Diffstat (limited to 'include/git2/submodule.h')
| -rw-r--r-- | include/git2/submodule.h | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/include/git2/submodule.h b/include/git2/submodule.h index b2b3039fe..c5cf00661 100644 --- a/include/git2/submodule.h +++ b/include/git2/submodule.h @@ -121,10 +121,9 @@ typedef int (*git_submodule_cb)( /** * Submodule update options structure * - * Use the GIT_SUBMODULE_UPDATE_OPTIONS_INIT to get the default settings, - * like this: + * Initialize with `GIT_SUBMODULE_UPDATE_OPTIONS_INIT`. Alternatively, you can + * use `git_submodule_update_init_options`. * - * git_submodule_update_options opts = GIT_SUBMODULE_UPDATE_OPTIONS_INIT; */ typedef struct git_submodule_update_options { unsigned int version; @@ -160,11 +159,13 @@ typedef struct git_submodule_update_options { GIT_FETCH_OPTIONS_INIT, 1 } /** - * Initializes a `git_submodule_update_options` with default values. - * Equivalent to creating an instance with GIT_SUBMODULE_UPDATE_OPTIONS_INIT. + * Initialize git_submodule_update_options structure * - * @param opts The `git_submodule_update_options` instance to initialize. - * @param version Version of struct; pass `GIT_SUBMODULE_UPDATE_OPTIONS_VERSION` + * Initializes a `git_submodule_update_options` with default values. Equivalent to + * creating an instance with `GIT_SUBMODULE_UPDATE_OPTIONS_INIT`. + * + * @param opts The `git_submodule_update_options` struct to initialize. + * @param version The struct version; pass `GIT_SUBMODULE_UPDATE_OPTIONS_VERSION`. * @return Zero on success; -1 on failure. */ GIT_EXTERN(int) git_submodule_update_init_options( |