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/status.h | |
| parent | 8ee183a2daa6695ec1e240a5d23626d63f9e7cf5 (diff) | |
| download | libgit2-ca5a15e51b361691087c92eb391411607d867f4b.tar.gz | |
docs: standardize comment block for git_*_init_options functions
Diffstat (limited to 'include/git2/status.h')
| -rw-r--r-- | include/git2/status.h | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/include/git2/status.h b/include/git2/status.h index 87bad2221..bba0d0537 100644 --- a/include/git2/status.h +++ b/include/git2/status.h @@ -191,11 +191,13 @@ typedef struct { #define GIT_STATUS_OPTIONS_INIT {GIT_STATUS_OPTIONS_VERSION} /** + * Initialize git_status_options structure + * * Initializes a `git_status_options` with default values. Equivalent to - * creating an instance with GIT_STATUS_OPTIONS_INIT. + * creating an instance with `GIT_STATUS_OPTIONS_INIT`. * - * @param opts The `git_status_options` instance to initialize. - * @param version Version of struct; pass `GIT_STATUS_OPTIONS_VERSION` + * @param opts The `git_status_options` struct to initialize. + * @param version The struct version; pass `GIT_STATUS_OPTIONS_VERSION`. * @return Zero on success; -1 on failure. */ GIT_EXTERN(int) git_status_init_options( |