summaryrefslogtreecommitdiff
path: root/include/git2/clone.h
diff options
context:
space:
mode:
authorPatrick Steinhardt <ps@pks.im>2018-06-01 13:17:28 +0200
committerGitHub <noreply@github.com>2018-06-01 13:17:28 +0200
commitbae6ed62010508c2e2b0559f9eee41e62e52eb7a (patch)
treefeec56cfeb1a259319743317ddce61e4fa787329 /include/git2/clone.h
parent771dfd1dd1c27a4693dfdfea521c07e72f456b29 (diff)
parent04c48afc3c2f3413883afee70ea748374e0a2293 (diff)
downloadlibgit2-bae6ed62010508c2e2b0559f9eee41e62e52eb7a.tar.gz
Merge pull request #4530 from tiennou/fix/docurium-missing-includes
Fix docurium missing includes
Diffstat (limited to 'include/git2/clone.h')
-rw-r--r--include/git2/clone.h14
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(