docs/git2/Tag.luadoc


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

--
-- Warning: AUTOGENERATED DOCS.
--

--- Class "Tag".
--
-- Extends <a href="Object.html">Object</a><br />
module("Tag")

--- Create a new Tag object.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_lookup">git_tag_lookup</a>:<p><p>
-- @param repo the repo to use when locating the tag..  Must be of type <a href="Repository.html">Repository</a>.
-- @param id identity of the tag to locate..  Must be of type <a href="OID.html">OID</a>.
-- @return <a href="Tag.html">Tag</a> or <code>nil</code> on error.
-- @return Error string.
-- @name Tag.lookup
function Tag.lookup(repo, id)
end

--- object method.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_target">git_tag_target</a>:<p><p>This method performs a repository lookup for the
--  given object and returns it
-- @return <a href="Object.html">Object</a> or <code>nil</code> on error.
-- @return Error string.
-- @name Tag:target
function Tag:target()
end

--- object method.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_name">git_tag_name</a>:<p><p>
-- @return <code>string</code>.
-- @name Tag:name
function Tag:name()
end

--- object method.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_tagger">git_tag_tagger</a>:<p><p>
-- @return <a href="Signature.html">Signature</a>.
-- @name Tag:tagger
function Tag:tagger()
end

--- object method.
--
-- <p>Calls <a href="http://libgit2.github.com/libgit2/#HEAD/group/tag/git_tag_message">git_tag_message</a>:<p><p>
-- @return <code>string</code>.
-- @name Tag:message
function Tag:message()
end

--- 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
function Object:id()
end

--- object method.
--
-- <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
function Object:owner()
end