summaryrefslogtreecommitdiff
path: root/include/git2/submodule.h
diff options
context:
space:
mode:
authorpunkymaniac <punkymaniac@protonmail.ch>2021-11-26 15:14:56 +0100
committerpunkymaniac <punkymaniac@protonmail.ch>2022-01-09 10:17:51 +0100
commit68bc511abb8574b843209685e0f05a88856d7ecf (patch)
tree33a6b33ea5a25faa708f999a489def55777d3df9 /include/git2/submodule.h
parent03aed8bca7473c51148e5fdf8a258bc57f452a85 (diff)
downloadlibgit2-68bc511abb8574b843209685e0f05a88856d7ecf.tar.gz
Add documentation about parameter and return value
Diffstat (limited to 'include/git2/submodule.h')
-rw-r--r--include/git2/submodule.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/include/git2/submodule.h b/include/git2/submodule.h
index c6eeb96dc..ed44e3dcf 100644
--- a/include/git2/submodule.h
+++ b/include/git2/submodule.h
@@ -229,6 +229,7 @@ GIT_EXTERN(int) git_submodule_lookup(
*
* @param out Pointer to store the copy of the submodule.
* @param source Original submodule to copy.
+ * @return 0
*/
GIT_EXTERN(int) git_submodule_dup(git_submodule **out, git_submodule *source);
@@ -320,6 +321,7 @@ GIT_EXTERN(int) git_submodule_clone(
* (but doesn't actually do the commit).
*
* @param submodule The submodule to finish adding.
+ * @return 0 or an error code.
*/
GIT_EXTERN(int) git_submodule_add_finalize(git_submodule *submodule);
@@ -589,6 +591,9 @@ GIT_EXTERN(int) git_submodule_repo_init(
* submodule config, acting like "git submodule sync". This is useful if
* you have altered the URL for the submodule (or it has been altered by a
* fetch of upstream changes) and you need to update your local repo.
+ *
+ * @param submodule The submodule to copy.
+ * @return 0 or an error code.
*/
GIT_EXTERN(int) git_submodule_sync(git_submodule *submodule);