diff options
Diffstat (limited to 'docs/git2/OdbObject.luadoc')
-rw-r--r-- | docs/git2/OdbObject.luadoc | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/docs/git2/OdbObject.luadoc b/docs/git2/OdbObject.luadoc new file mode 100644 index 0000000..b08dd12 --- /dev/null +++ b/docs/git2/OdbObject.luadoc @@ -0,0 +1,52 @@ +-- +-- Warning: AUTOGENERATED DOCS. +-- + +--- Class "OdbObject". +-- +module("OdbObject") + +--- Destroy this object (will be called by Garbage Collector). +-- +-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_free">git_odb_object_free</a>:<p><p>This method must always be called once a `git_odb_object` is no +-- longer needed, otherwise memory will leak. +-- @name OdbObject:free +function OdbObject:free() +end + +--- object method. +-- +-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_id">git_odb_object_id</a>:<p><p>This is the OID from which the object was read from +-- @return <a href="OID.html">OID</a>. +-- @name OdbObject:id +function OdbObject:id() +end + +--- object method. +-- +-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_data">git_odb_object_data</a>:<p><p>This is the uncompressed, raw data as read from the ODB, +-- without the leading header.<p> This pointer is owned by the object and shall not be free'd. +-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_size">git_odb_object_size</a>:<p><p>This is the real size of the `data` buffer, not the +-- actual size of the object. +-- @return <code>string</code>. +-- @name OdbObject:data +function OdbObject:data() +end + +--- object method. +-- +-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_size">git_odb_object_size</a>:<p><p>This is the real size of the `data` buffer, not the +-- actual size of the object. +-- @return <code>integer</code>. +-- @name OdbObject:size +function OdbObject:size() +end + +--- object method. +-- +-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/odb/git_odb_object_type">git_odb_object_type</a>:<p><p> +-- @return <code>string</code>. +-- @name OdbObject:type +function OdbObject:type() +end + |