summaryrefslogtreecommitdiff
path: root/include/git2/object.h
diff options
context:
space:
mode:
authornulltoken <emeric.fermas@gmail.com>2012-11-19 18:49:25 +0100
committernulltoken <emeric.fermas@gmail.com>2012-12-01 08:34:29 +0100
commitbc05f30c470f7d147ff85b30ad5719bbce70a4a3 (patch)
tree5a425363075c894533f8bd80fcefb7bcfc289ca7 /include/git2/object.h
parent621730383a2298431fd3ea3cbc754f7cf18a1eba (diff)
downloadlibgit2-bc05f30c470f7d147ff85b30ad5719bbce70a4a3.tar.gz
object: refine git_object_peel() error report
Diffstat (limited to 'include/git2/object.h')
-rw-r--r--include/git2/object.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/include/git2/object.h b/include/git2/object.h
index fcc56cb27..e5ca17e16 100644
--- a/include/git2/object.h
+++ b/include/git2/object.h
@@ -179,8 +179,9 @@ GIT_EXTERN(size_t) git_object__size(git_otype type);
*
* @param peeled Pointer to the peeled git_object
* @param object The object to be processed
- * @param target_type The type of the requested object
- * @return 0 or an error code
+ * @param target_type The type of the requested object (GIT_OBJ_COMMIT,
+ * GIT_OBJ_TAG, GIT_OBJ_TREE, GIT_OBJ_BLOB or GIT_OBJ_ANY).
+ * @return 0 on success, GIT_EAMBIGUOUS, GIT_ENOTFOUND or an error code
*/
GIT_EXTERN(int) git_object_peel(
git_object **peeled,