Updated docs.

This commit is contained in:
2010-07-29 04:27:37 +03:00
parent a1c69ea52c
commit 820057f842
10 changed files with 1334 additions and 136 deletions

94
doc/TimeExt/Base.html Normal file
View File

@@ -0,0 +1,94 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Module: TimeExt::Base</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '..';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (B)</a> &raquo;
<span class='title'><a href="../TimeExt.html" title="TimeExt (module)">TimeExt</a></span>
&raquo;
<span class="title">Base</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: TimeExt::Base
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/time_ext.rb</dd>
</dl>
<div class="clear"></div>
<h2>Constant Summary</h2>
<dl class="constants">
<dt id="TIME_EXT_UNITS-constant" class="">TIME_EXT_UNITS =
</dt>
<dd><pre class="code"><span class='lbrack token'>[</span><span class='symbol val'>:year</span><span class='comma token'>,</span> <span class='symbol val'>:month</span><span class='comma token'>,</span> <span class='symbol val'>:day</span><span class='comma token'>,</span> <span class='symbol val'>:hour</span><span class='comma token'>,</span> <span class='symbol val'>:min</span><span class='comma token'>,</span> <span class='symbol val'>:sec</span><span class='comma token'>,</span> <span class='symbol val'>:usec</span><span class='rbrack token'>]</span>
</pre></dd>
</dl>
</div>
<div id="footer">
Generated on Thu Jul 29 04:27:15 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>
</body>
</html>

View File

@@ -0,0 +1,212 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta name="Content-Type" content="text/html; charset=utf-8" />
<title>Module: TimeExt::MethodChain</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
relpath = '..';
if (relpath != '') relpath += '/';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<script type="text/javascript" charset="utf-8">
if (window.top.frames.main) document.body.className = 'frames';
</script>
<div id="header">
<div id="menu">
<a href="../_index.html">Index (M)</a> &raquo;
<span class='title'><a href="../TimeExt.html" title="TimeExt (module)">TimeExt</a></span>
&raquo;
<span class="title">MethodChain</span>
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>
<div id="search">
<a id="class_list_link" href="#">Class List</a>
<a id="method_list_link" href="#">Method List</a>
<a id ="file_list_link" href="#">File List</a>
</div>
<div class="clear"></div>
</div>
<iframe id="search_frame"></iframe>
<div id="content"><h1>Module: TimeExt::MethodChain
</h1>
<dl class="box">
<dt class="r1">Included in:</dt>
<dd class="r1"><a href="../Time.html" title="Time (class)">Time</a></dd>
<dt class="r2 last">Defined in:</dt>
<dd class="r2 last">lib/time_ext/method_chain.rb</dd>
</dl>
<div class="clear"></div>
<h2>
Instance Method Summary
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#add_to_chain-instance_method" title="#add_to_chain (instance method)">- (Object) <strong>add_to_chain</strong>(method, *args, &amp;block) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#call_chain-instance_method" title="#call_chain (instance method)">- (Object) <strong>call_chain</strong>(custom_block = nil, &amp;block) </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<p class="signature first" id="add_to_chain-instance_method">
- (<tt>Object</tt>) <strong>add_to_chain</strong>(method, *args, &amp;block)
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
4
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/time_ext/method_chain.rb', line 4</span>
<span class='def def kw'>def</span> <span class='add_to_chain identifier id'>add_to_chain</span><span class='lparen token'>(</span><span class='method identifier id'>method</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
<span class='@method_chain ivar id'>@method_chain</span> <span class='opasgn op'>||=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
<span class='@method_chain ivar id'>@method_chain</span> <span class='lshft op'>&lt;&lt;</span> <span class='lbrack token'>[</span><span class='method identifier id'>method</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='comma token'>,</span> <span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='block identifier id'>block</span><span class='rbrack token'>]</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<p class="signature " id="call_chain-instance_method">
- (<tt>Object</tt>) <strong>call_chain</strong>(custom_block = nil, &amp;block)
</p><table class="source_code">
<tr>
<td>
<pre class="lines">
9
10
11
12
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/time_ext/method_chain.rb', line 9</span>
<span class='def def kw'>def</span> <span class='call_chain identifier id'>call_chain</span><span class='lparen token'>(</span><span class='custom_block identifier id'>custom_block</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='block identifier id'>block</span><span class='rparen token'>)</span>
<span class='method identifier id'>method</span><span class='comma token'>,</span> <span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='iblock identifier id'>iblock</span> <span class='assign token'>=</span> <span class='@method_chain ivar id'>@method_chain</span><span class='dot token'>.</span><span class='pop identifier id'>pop</span>
<span class='return return kw'>return</span> <span class='nil nil kw'>nil</span> <span class='if if_mod kw'>if</span> <span class='method identifier id'>method</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
<span class='iblock identifier id'>iblock</span> <span class='assign token'>=</span> <span class='custom_block identifier id'>custom_block</span> <span class='if if_mod kw'>if</span> <span class='notop op'>!</span><span class='custom_block identifier id'>custom_block</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
<span class='method identifier id'>method</span><span class='comma token'>,</span> <span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='iblock identifier id'>iblock</span> <span class='assign token'>=</span> <span class='yield yield kw'>yield</span><span class='lparen token'>(</span><span class='method identifier id'>method</span><span class='comma token'>,</span> <span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='iblock identifier id'>iblock</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span>
<span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='method identifier id'>method</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='iblock identifier id'>iblock</span><span class='rparen token'>)</span>
<span class='end end kw'>end</span>
</pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Thu Jul 29 04:27:15 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>
</body>
</html>