Commit ef5ffed39a91e8e645ed77f52ec862d47b081e9c

Vicent Marti 2011-06-01T18:23:36

object: Update documentation

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/git2/object.h b/include/git2/object.h
index 16dde8e..7fca1c9 100644
--- a/include/git2/object.h
+++ b/include/git2/object.h
@@ -77,6 +77,12 @@ GIT_EXTERN(git_otype) git_object_type(const git_object *obj);
 /**
  * Get the repository that owns this object
  *
+ * Freeing or calling `git_repository_close` on the
+ * returned pointer will invalidate the actual object.
+ *
+ * Any other operation may be run on the repository without
+ * affecting the object.
+ *
  * @param obj the object
  * @return the repository who owns this object
  */