Copied details from libgit2 API docs.

Author: Neopallium

git2.luadoc

@@ -4,6 +4,8 @@
 
 --- Module git2.
 --
+-- See <a href="http://libgit2.github.com/libgit2/#HEAD">libgit2 API docs</a>.
+-- 
 -- <br />Class <a href="StrArray.html">StrArray</a>
 -- <br />Class <a href="Repository.html">Repository</a>
 -- <br />Class <a href="Config.html">Config</a>
@@ -26,10 +28,10 @@
 -- <br />Class <a href="Reference.html">Reference</a>
 module("git2")
 
---- module function
+--- module function.
 --
--- @name git2.version
 -- @return <code>nil</code>.
+-- @name git2.version
 function git2.version()
 end
 

git2/Blob.luadoc

@@ -5,77 +5,97 @@
 --- Class "Blob".
 --
 -- Extends <a href="Object.html">Object</a><br />
--- <br />
 module("Blob")
 
---- Create a new Blob object
+--- Create a new Blob object.
 --
--- @name Blob.lookup
--- @param repo Must be of type `Repository`.
--- @param id Must be of type `OID`.
--- @return <code>Blob</code> or <code>nil</code> on error.
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_lookup">git_blob_lookup</a>:<p><p>
+-- @param repo the repo to use when locating the blob..  Must be of type <a href="Repository.html">Repository</a>.
+-- @param id identity of the blob to locate..  Must be of type <a href="OID.html">OID</a>.
+-- @return <a href="Blob.html">Blob</a> or <code>nil</code> on error.
 -- @return Error string.
+-- @name Blob.lookup
 function Blob.lookup(repo, id)
 end
 
---- module function
+--- module function.
 --
--- @name Blob.fromfile
--- @param repo Must be of type `Repository`.
--- @param path Must be of type `string`.
--- @return <code>OID</code> or <code>nil</code> on error.
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_create_fromfile">git_blob_create_fromfile</a>:<p><p>
+-- @param repo repository where the blob will be written.  this repository cannot be bare.  Must be of type <a href="Repository.html">Repository</a>.
+-- @param path file from which the blob will be created,  relative to the repository's working dir.  Must be of type <code>string</code>.
+-- @return <a href="OID.html">OID</a> or <code>nil</code> on error.
 -- @return Error string.
+-- @name Blob.fromfile
 function Blob.fromfile(repo, path)
 end
 
---- module function
+--- module function.
 --
--- @name Blob.frombuffer
--- @param repo Must be of type `Repository`.
--- @param buffer Must be of type `string`.
--- @return <code>OID</code> or <code>nil</code> on error.
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_create_frombuffer">git_blob_create_frombuffer</a>:<p><p>
+-- @param repo repository where to blob will be written.  Must be of type <a href="Repository.html">Repository</a>.
+-- @param buffer data to be written into the blob.  Must be of type <code>string</code>.
+-- @return <a href="OID.html">OID</a> or <code>nil</code> on error.
 -- @return Error string.
+-- @name Blob.frombuffer
 function Blob.frombuffer(repo, buffer)
 end
 
 --- object method.
 --
--- @name Blob:rawcontent
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawcontent">git_blob_rawcontent</a>:<p><p>A pointer to the raw content of a blob is returned;
+--  this pointer is owned internally by the object and shall
+--  not be free'd. The pointer may be invalidated at a later
+--  time.
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p>
 -- @return <code>string</code>.
+-- @name Blob:rawcontent
 function Blob:rawcontent()
 end
 
 --- object method.
 --
--- @name Blob:rawsize
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/blob/git_blob_rawsize">git_blob_rawsize</a>:<p><p>
 -- @return <code>integer</code>.
+-- @name Blob:rawsize
 function Blob:rawsize()
 end
 
---- Destroy this object.
+--- Destroy this object (will be called by Garbage Collector).
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing
+--  object; note that git_objects are owned and cached by the repository
+--  so the object may or may not be freed after this library call,
+--  depending on how agressive is the caching mechanism used
+--  by the repository.<p> IMPORTANT:
+--  It *is* necessary to call this method when you stop using
+--  an object. Failure to do so will cause a memory leak.
 -- @name Object:free
 function Object:free()
 end
 
 --- object method.
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p>
+-- @return <a href="OID.html">OID</a>.
 -- @name Object:id
--- @return <code>OID</code>.
 function Object:id()
 end
 
 --- object method.
 --
--- @name Object:type
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p>
 -- @return <code>string</code>.
+-- @name Object:type
 function Object:type()
 end
 
 --- object method.
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the
+--  returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without
+--  affecting the object.
+-- @return <a href="Repository.html">Repository</a>.
 -- @name Object:owner
--- @return <code>Repository</code>.
 function Object:owner()
 end
 

git2/Commit.luadoc

@@ -5,133 +5,156 @@
 --- Class "Commit".
 --
 -- Extends <a href="Object.html">Object</a><br />
--- <br />
 module("Commit")
 
---- Create a new Commit object
+--- Create a new Commit object.
 --
--- @name Commit.lookup
--- @param repo Must be of type `Repository`.
--- @param id Must be of type `OID`.
--- @return <code>Commit</code> or <code>nil</code> on error.
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_lookup">git_commit_lookup</a>:<p><p>
+-- @param repo the repo to use when locating the commit..  Must be of type <a href="Repository.html">Repository</a>.
+-- @param id identity of the commit to locate. If the object is   an annotated tag it will be peeled back to the commit..  Must be of type <a href="OID.html">OID</a>.
+-- @return <a href="Commit.html">Commit</a> or <code>nil</code> on error.
 -- @return Error string.
+-- @name Commit.lookup
 function Commit.lookup(repo, id)
 end
 
---- module function
+--- module function.
 --
--- @name Commit.create
--- @param oid Must be of type `OID`.
--- @param repo Must be of type `Repository`.
--- @param update_ref Must be of type `string`.
--- @param author Must be of type `Signature`.
--- @param committer Must be of type `Signature`.
--- @param message_encoding Must be of type `string`.
--- @param message Must be of type `string`.
--- @param tree Must be of type `Tree`.
--- @param parent Must be of type `Commit`.
+-- @param oid Must be of type <a href="OID.html">OID</a>.
+-- @param repo Must be of type <a href="Repository.html">Repository</a>.
+-- @param update_ref Must be of type <code>string</code>.
+-- @param author Must be of type <a href="Signature.html">Signature</a>.
+-- @param committer Must be of type <a href="Signature.html">Signature</a>.
+-- @param message_encoding Must be of type <code>string</code>.
+-- @param message Must be of type <code>string</code>.
+-- @param tree Must be of type <a href="Tree.html">Tree</a>.
+-- @param parent Must be of type <a href="Commit.html">Commit</a>.
 -- @return <code>true</code> if no error.
 -- @return Error string.
+-- @name Commit.create
 function Commit.create(oid, repo, update_ref, author, committer, message_encoding, message, tree, parent)
 end
 
 --- object method.
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_id">git_commit_id</a>:<p><p>
+-- @return <a href="OID.html">OID</a>.
 -- @name Commit:id
--- @return <code>OID</code>.
 function Commit:id()
 end
 
 --- object method.
 --
--- @name Commit:message_encoding
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_message_encoding">git_commit_message_encoding</a>:<p><p>The encoding may be NULL if the `encoding` header
+--  in the commit is missing; in that case UTF-8 is assumed.
 -- @return <code>string</code>.
+-- @name Commit:message_encoding
 function Commit:message_encoding()
 end
 
 --- object method.
 --
--- @name Commit:message
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_message">git_commit_message</a>:<p><p>
 -- @return <code>string</code>.
+-- @name Commit:message
 function Commit:message()
 end
 
 --- object method.
 --
--- @name Commit:time
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_time">git_commit_time</a>:<p><p>
 -- @return <code>integer</code>.
+-- @name Commit:time
 function Commit:time()
 end
 
 --- object method.
 --
--- @name Commit:time_offset
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_time_offset">git_commit_time_offset</a>:<p><p>
 -- @return <code>integer</code>.
+-- @name Commit:time_offset
 function Commit:time_offset()
 end
 
 --- object method.
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_committer">git_commit_committer</a>:<p><p>
+-- @return <a href="Signature.html">Signature</a>.
 -- @name Commit:committer
--- @return <code>Signature</code>.
 function Commit:committer()
 end
 
 --- object method.
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_author">git_commit_author</a>:<p><p>
+-- @return <a href="Signature.html">Signature</a>.
 -- @name Commit:author
--- @return <code>Signature</code>.
 function Commit:author()
 end
 
 --- object method.
 --
--- @name Commit:tree
--- @return <code>Tree</code> or <code>nil</code> on error.
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_tree">git_commit_tree</a>:<p><p>
+-- @return <a href="Tree.html">Tree</a> or <code>nil</code> on error.
 -- @return Error string.
+-- @name Commit:tree
 function Commit:tree()
 end
 
 --- object method.
 --
--- @name Commit:parentcount
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_parentcount">git_commit_parentcount</a>:<p><p>
 -- @return <code>integer</code>.
+-- @name Commit:parentcount
 function Commit:parentcount()
 end
 
 --- object method.
 --
--- @name Commit:parent
--- @param n Must be of type `integer`.
--- @return <code>Commit</code> or <code>nil</code> on error.
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/commit/git_commit_parent">git_commit_parent</a>:<p><p>
+-- @param n the position of the parent (from 0 to `parentcount`).  Must be of type <code>integer</code>.
+-- @return <a href="Commit.html">Commit</a> or <code>nil</code> on error.
 -- @return Error string.
+-- @name Commit:parent
 function Commit:parent(n)
 end
 
---- Destroy this object.
+--- Destroy this object (will be called by Garbage Collector).
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_free">git_object_free</a>:<p><p>This method instructs the library to close an existing
+--  object; note that git_objects are owned and cached by the repository
+--  so the object may or may not be freed after this library call,
+--  depending on how agressive is the caching mechanism used
+--  by the repository.<p> IMPORTANT:
+--  It *is* necessary to call this method when you stop using
+--  an object. Failure to do so will cause a memory leak.
 -- @name Object:free
 function Object:free()
 end
 
 --- object method.
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_id">git_object_id</a>:<p><p>
+-- @return <a href="OID.html">OID</a>.
 -- @name Object:id
--- @return <code>OID</code>.
 function Object:id()
 end
 
 --- object method.
 --
--- @name Object:type
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_type">git_object_type</a>:<p><p>
 -- @return <code>string</code>.
+-- @name Object:type
 function Object:type()
 end
 
 --- object method.
 --
+-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/object/git_object_owner">git_object_owner</a>:<p><p>Freeing or calling `git_repository_close` on the
+--  returned pointer will invalidate the actual object.<p> Any other operation may be run on the repository without
+--  affecting the object.
+-- @return <a href="Repository.html">Repository</a>.
 -- @name Object:owner
--- @return <code>Repository</code>.
 function Object:owner()
 end