summaryrefslogtreecommitdiff
path: root/include/git2/clone.h
diff options
context:
space:
mode:
authorBen Straub <bstraub@github.com>2012-07-31 21:25:48 -0700
committerBen Straub <bstraub@github.com>2012-07-31 21:25:48 -0700
commit8b67f72b9cba387f5e85ce869448d88cce23076f (patch)
treefdde01a9cbd31b8b1ca0ad06194882110988e2d8 /include/git2/clone.h
parent5f4d2f9f6574fd41d9340ef80de0813bde80b76d (diff)
downloadlibgit2-8b67f72b9cba387f5e85ce869448d88cce23076f.tar.gz
Add documentation for clone methods.
Diffstat (limited to 'include/git2/clone.h')
-rw-r--r--include/git2/clone.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/git2/clone.h b/include/git2/clone.h
index f134a045..40292ed5 100644
--- a/include/git2/clone.h
+++ b/include/git2/clone.h
@@ -23,7 +23,8 @@
GIT_BEGIN_DECL
/**
- * TODO
+ * Clone a remote repository, and checkout the branch pointed to by the remote
+ * HEAD.
*
* @param out pointer that will receive the resulting repository object
* @param origin_url repository to clone from
@@ -40,7 +41,7 @@ GIT_EXTERN(int) git_clone(git_repository **out,
git_checkout_opts *checkout_opts);
/**
- * TODO
+ * Create a bare clone of a remote repository.
*
* @param out pointer that will receive the resulting repository object
* @param origin_url repository to clone from