updated a bunch of the documentation
[rubygit.git] / doc / classes / Git / Author.html
blob85441f9699fb116934d265c6f9e76a793d1b7f89
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::Author</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::Author</td>
54 </tr>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
57 <td>
58 <a href="../../files/lib/git/author_rb.html">
59 lib/git/author.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="Object.html">
69 Object
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="#M000024">new</a>&nbsp;&nbsp;
92 </div>
93 </div>
95 </div>
98 <!-- if includes -->
100 <div id="section">
106 <div id="attribute-list">
107 <h3 class="section-bar">Attributes</h3>
109 <div class="name-list">
110 <table>
111 <tr class="top-aligned-row context-row">
112 <td class="context-item-name">date</td>
113 <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
114 <td class="context-item-desc"></td>
115 </tr>
116 <tr class="top-aligned-row context-row">
117 <td class="context-item-name">email</td>
118 <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
119 <td class="context-item-desc"></td>
120 </tr>
121 <tr class="top-aligned-row context-row">
122 <td class="context-item-name">name</td>
123 <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
124 <td class="context-item-desc"></td>
125 </tr>
126 </table>
127 </div>
128 </div>
132 <!-- if method_list -->
133 <div id="methods">
134 <h3 class="section-bar">Public Class methods</h3>
136 <div id="method-M000024" class="method-detail">
137 <a name="M000024"></a>
139 <div class="method-heading">
140 <a href="#M000024" class="method-signature">
141 <span class="method-name">new</span><span class="method-args">(author_string)</span>
142 </a>
143 </div>
145 <div class="method-description">
146 <p><a class="source-toggle" href="#"
147 onclick="toggleCode('M000024-source');return false;">[Source]</a></p>
148 <div class="method-source-code" id="M000024-source">
149 <pre>
150 <span class="ruby-comment cmt"># File lib/git/author.rb, line 5</span>
151 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">author_string</span>)
152 <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">m</span> = <span class="ruby-regexp re">/(.*?) &lt;(.*?)&gt; (\d+) (.*)/</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">author_string</span>)
153 <span class="ruby-ivar">@name</span> = <span class="ruby-identifier">m</span>[<span class="ruby-value">1</span>]
154 <span class="ruby-ivar">@email</span> = <span class="ruby-identifier">m</span>[<span class="ruby-value">2</span>]
155 <span class="ruby-ivar">@date</span> = <span class="ruby-constant">Time</span>.<span class="ruby-identifier">at</span>(<span class="ruby-identifier">m</span>[<span class="ruby-value">3</span>].<span class="ruby-identifier">to_i</span>)
156 <span class="ruby-keyword kw">end</span>
157 <span class="ruby-keyword kw">end</span>
158 </pre>
159 </div>
160 </div>
161 </div>
164 </div>
167 </div>
170 <div id="validator-badges">
171 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
172 </div>
174 </body>
175 </html>