summaryrefslogtreecommitdiff
path: root/include/git2/object.h
diff options
context:
space:
mode:
authorVicent Marti <tanoku@gmail.com>2011-06-16 03:02:46 +0200
committerVicent Marti <tanoku@gmail.com>2011-06-16 03:06:22 +0200
commitd144c569f372aace4b71e595cb541111730edce4 (patch)
treebe63023d8be74794fbe4e12214116914a1dad92b /include/git2/object.h
parentf1d018513aced2fb4e6c87f2d417b6f826dbe998 (diff)
downloadlibgit2-d144c569f372aace4b71e595cb541111730edce4.tar.gz
Update documentation
Fix all the missmatched arguments in the docs
Diffstat (limited to 'include/git2/object.h')
-rw-r--r--include/git2/object.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/include/git2/object.h b/include/git2/object.h
index 83d37a26..07ba1a1c 100644
--- a/include/git2/object.h
+++ b/include/git2/object.h
@@ -82,12 +82,12 @@ GIT_EXTERN(int) git_object_lookup(
* The special value 'GIT_OBJ_ANY' may be passed to let
* the method guess the object's type.
*
- * @param object pointer to the looked-up object
+ * @param object_out pointer where to store the looked-up object
* @param repo the repository to look up the object
* @param id a short identifier for the object
* @param len the length of the short identifier
* @param type the type of the object
- * @return a reference to the object
+ * @return 0 on success; error code otherwise
*/
GIT_EXTERN(int) git_object_lookup_prefix(
git_object **object_out,