added documentation and a license file
[rubygit.git] / doc / classes / Git / Object / Tag.html
blob9055efffaa8998e96d59e9c07ad4226526a71690
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <title>Class: Git::Object::Tag</title>
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10 <meta http-equiv="Content-Script-Type" content="text/javascript" />
11 <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
12 <script type="text/javascript">
13 // <![CDATA[
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
24 else
25 return false;
27 elemStyle = elem.style;
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
31 } else {
32 elemStyle.display = "none"
35 return true;
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
41 // ]]>
42 </script>
44 </head>
45 <body>
49 <div id="classHeader">
50 <table class="header-table">
51 <tr class="top-aligned-row">
52 <td><strong>Class</strong></td>
53 <td class="class-name-in-header">Git::Object::Tag</td>
54 </tr>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
57 <td>
58 <a href="../../../files/lib/git/object_rb.html">
59 lib/git/object.rb
60 </a>
61 <br />
62 </td>
63 </tr>
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
67 <td>
68 <a href="AbstractObject.html">
69 AbstractObject
70 </a>
71 </td>
72 </tr>
73 </table>
74 </div>
75 <!-- banner header -->
77 <div id="bodyContent">
81 <div id="contextContent">
85 </div>
87 <div id="method-list">
88 <h3 class="section-bar">Methods</h3>
90 <div class="name-list">
91 <a href="#M000130">new</a>&nbsp;&nbsp;
92 <a href="#M000131">setup</a>&nbsp;&nbsp;
93 </div>
94 </div>
96 </div>
99 <!-- if includes -->
101 <div id="section">
107 <div id="attribute-list">
108 <h3 class="section-bar">Attributes</h3>
110 <div class="name-list">
111 <table>
112 <tr class="top-aligned-row context-row">
113 <td class="context-item-name">name</td>
114 <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
115 <td class="context-item-desc"></td>
116 </tr>
117 </table>
118 </div>
119 </div>
123 <!-- if method_list -->
124 <div id="methods">
125 <h3 class="section-bar">Public Class methods</h3>
127 <div id="method-M000130" class="method-detail">
128 <a name="M000130"></a>
130 <div class="method-heading">
131 <a href="#M000130" class="method-signature">
132 <span class="method-name">new</span><span class="method-args">(base, sha, name)</span>
133 </a>
134 </div>
136 <div class="method-description">
137 <p><a class="source-toggle" href="#"
138 onclick="toggleCode('M000130-source');return false;">[Source]</a></p>
139 <div class="method-source-code" id="M000130-source">
140 <pre>
141 <span class="ruby-comment cmt"># File lib/git/object.rb, line 74</span>
142 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">sha</span>, <span class="ruby-identifier">name</span>)
143 <span class="ruby-keyword kw">super</span>(<span class="ruby-identifier">base</span>, <span class="ruby-identifier">sha</span>)
144 <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">name</span>
145 <span class="ruby-keyword kw">end</span>
146 </pre>
147 </div>
148 </div>
149 </div>
151 <h3 class="section-bar">Public Instance methods</h3>
153 <div id="method-M000131" class="method-detail">
154 <a name="M000131"></a>
156 <div class="method-heading">
157 <a href="#M000131" class="method-signature">
158 <span class="method-name">setup</span><span class="method-args">()</span>
159 </a>
160 </div>
162 <div class="method-description">
163 <p><a class="source-toggle" href="#"
164 onclick="toggleCode('M000131-source');return false;">[Source]</a></p>
165 <div class="method-source-code" id="M000131-source">
166 <pre>
167 <span class="ruby-comment cmt"># File lib/git/object.rb, line 79</span>
168 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">setup</span>
169 <span class="ruby-ivar">@type</span> = <span class="ruby-value str">'tag'</span>
170 <span class="ruby-keyword kw">end</span>
171 </pre>
172 </div>
173 </div>
174 </div>
177 </div>
180 </div>
183 <div id="validator-badges">
184 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
185 </div>
187 </body>
188 </html>