Start of luagit2 API docs.

Author: Neopallium

git2.luadoc

@@ -0,0 +1,35 @@
+--
+-- Warning: AUTOGENERATED DOCS.
+--
+
+--- Module git2.
+--
+-- <br />Class <a href="StrArray.html">StrArray</a>
+-- <br />Class <a href="Repository.html">Repository</a>
+-- <br />Class <a href="Config.html">Config</a>
+-- <br />Class <a href="OdbObject.html">OdbObject</a>
+-- <br />Class <a href="OID.html">OID</a>
+-- <br />Class <a href="OID_Shorten.html">OID_Shorten</a>
+-- <br />Class <a href="ODB.html">ODB</a>
+-- <br />Class <a href="ODBBackend.html">ODBBackend</a>
+-- <br />Class <a href="Index.html">Index</a>
+-- <br />Class <a href="IndexEntry.html">IndexEntry</a>
+-- <br />Class <a href="IndexEntryUnmerged.html">IndexEntryUnmerged</a>
+-- <br />Class <a href="Object.html">Object</a>
+-- <br />Class <a href="Blob.html">Blob</a>
+-- <br />Class <a href="Signature.html">Signature</a>
+-- <br />Class <a href="Commit.html">Commit</a>
+-- <br />Class <a href="Tree.html">Tree</a>
+-- <br />Class <a href="TreeEntry.html">TreeEntry</a>
+-- <br />Class <a href="Tag.html">Tag</a>
+-- <br />Class <a href="RevWalk.html">RevWalk</a>
+-- <br />Class <a href="Reference.html">Reference</a>
+module("git2")
+
+--- module function
+--
+-- @name git2.version
+-- @return <code>nil</code>.
+function git2.version()
+end
+

git2/Blob.luadoc

@@ -0,0 +1,81 @@
+--
+-- Warning: AUTOGENERATED DOCS.
+--
+
+--- Class "Blob".
+--
+-- Extends <a href="Object.html">Object</a><br />
+-- <br />
+module("Blob")
+
+--- 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.
+-- @return Error string.
+function Blob.lookup(repo, id)
+end
+
+--- 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.
+-- @return Error string.
+function Blob.fromfile(repo, path)
+end
+
+--- 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.
+-- @return Error string.
+function Blob.frombuffer(repo, buffer)
+end
+
+--- object method.
+--
+-- @name Blob:rawcontent
+-- @return <code>string</code>.
+function Blob:rawcontent()
+end
+
+--- object method.
+--
+-- @name Blob:rawsize
+-- @return <code>integer</code>.
+function Blob:rawsize()
+end
+
+--- Destroy this object.
+--
+-- @name Object:free
+function Object:free()
+end
+
+--- object method.
+--
+-- @name Object:id
+-- @return <code>OID</code>.
+function Object:id()
+end
+
+--- object method.
+--
+-- @name Object:type
+-- @return <code>string</code>.
+function Object:type()
+end
+
+--- object method.
+--
+-- @name Object:owner
+-- @return <code>Repository</code>.
+function Object:owner()
+end
+

git2/Commit.luadoc

@@ -0,0 +1,137 @@
+--
+-- Warning: AUTOGENERATED DOCS.
+--
+
+--- Class "Commit".
+--
+-- Extends <a href="Object.html">Object</a><br />
+-- <br />
+module("Commit")
+
+--- 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.
+-- @return Error string.
+function Commit.lookup(repo, id)
+end
+
+--- 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`.
+-- @return <code>true</code> if no error.
+-- @return Error string.
+function Commit.create(oid, repo, update_ref, author, committer, message_encoding, message, tree, parent)
+end
+
+--- object method.
+--
+-- @name Commit:id
+-- @return <code>OID</code>.
+function Commit:id()
+end
+
+--- object method.
+--
+-- @name Commit:message_encoding
+-- @return <code>string</code>.
+function Commit:message_encoding()
+end
+
+--- object method.
+--
+-- @name Commit:message
+-- @return <code>string</code>.
+function Commit:message()
+end
+
+--- object method.
+--
+-- @name Commit:time
+-- @return <code>integer</code>.
+function Commit:time()
+end
+
+--- object method.
+--
+-- @name Commit:time_offset
+-- @return <code>integer</code>.
+function Commit:time_offset()
+end
+
+--- object method.
+--
+-- @name Commit:committer
+-- @return <code>Signature</code>.
+function Commit:committer()
+end
+
+--- object method.
+--
+-- @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.
+-- @return Error string.
+function Commit:tree()
+end
+
+--- object method.
+--
+-- @name Commit:parentcount
+-- @return <code>integer</code>.
+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.
+-- @return Error string.
+function Commit:parent(n)
+end
+
+--- Destroy this object.
+--
+-- @name Object:free
+function Object:free()
+end
+
+--- object method.
+--
+-- @name Object:id
+-- @return <code>OID</code>.
+function Object:id()
+end
+
+--- object method.
+--
+-- @name Object:type
+-- @return <code>string</code>.
+function Object:type()
+end
+
+--- object method.
+--
+-- @name Object:owner
+-- @return <code>Repository</code>.
+function Object:owner()
+end
+

git2/Config.luadoc

@@ -0,0 +1,127 @@
+--
+-- Warning: AUTOGENERATED DOCS.
+--
+
+--- Class "Config".
+--
+-- <br />
+module("Config")
+
+--- Create a new Config object
+--
+-- @name Config.new
+-- @return <code>Config</code> or <code>nil</code> on error.
+-- @return Error string.
+function Config.new()
+end
+
+--- Create a new Config object
+--
+-- @name Config.open
+-- @param path Must be of type `string`.
+-- @return <code>Config</code> or <code>nil</code> on error.
+-- @return Error string.
+function Config.open(path)
+end
+
+--- Destroy this object.
+--
+-- @name Config:free
+function Config:free()
+end
+
+--- object method.
+--
+-- @name Config:add_file_ondisk
+-- @param path Must be of type `string`.
+-- @param priority Must be of type `integer`.
+-- @return <code>true</code> if no error.
+-- @return Error string.
+function Config:add_file_ondisk(path, priority)
+end
+
+--- object method.
+--
+-- @name Config:get_int32
+-- @param name Must be of type `string`.
+-- @return <code>integer</code> or <code>nil</code> on error.
+-- @return Error string.
+function Config:get_int32(name)
+end
+
+--- object method.
+--
+-- @name Config:set_int32
+-- @param name Must be of type `string`.
+-- @param value Must be of type `integer`.
+-- @return <code>true</code> if no error.
+-- @return Error string.
+function Config:set_int32(name, value)
+end
+
+--- object method.
+--
+-- @name Config:get_int64
+-- @param name Must be of type `string`.
+-- @return <code>integer</code> or <code>nil</code> on error.
+-- @return Error string.
+function Config:get_int64(name)
+end
+
+--- object method.
+--
+-- @name Config:set_int64
+-- @param name Must be of type `string`.
+-- @param value Must be of type `integer`.
+-- @return <code>true</code> if no error.
+-- @return Error string.
+function Config:set_int64(name, value)
+end
+
+--- object method.
+--
+-- @name Config:get_bool
+-- @param name Must be of type `string`.
+-- @return <code>boolean</code> or <code>nil</code> on error.
+-- @return Error string.
+function Config:get_bool(name)
+end
+
+--- object method.
+--
+-- @name Config:set_bool
+-- @param value Must be of type `boolean`.
+-- @param name Must be of type `string`.
+-- @return <code>true</code> if no error.
+-- @return Error string.
+function Config:set_bool(value, name)
+end
+
+--- object method.
+--
+-- @name Config:get_string
+-- @param name Must be of type `string`.
+-- @return <code>string</code> or <code>nil</code> on error.
+-- @return Error string.
+function Config:get_string(name)
+end
+
+--- object method.
+--
+-- @name Config:set_string
+-- @param name Must be of type `string`.
+-- @param value Must be of type `string`.
+-- @return <code>true</code> if no error.
+-- @return Error string.
+function Config:set_string(name, value)
+end
+
+--- object method.
+--
+-- @name Config:delete
+-- @param name Must be of type `string`.
+-- @return <code>true</code> if no error.
+-- @return Error string.
+function Config:delete(name)
+end
+