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

File diff suppressed because it is too large Load Diff

93
doc/TimeExt.html Normal file
View File

@@ -0,0 +1,93 @@
<!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</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 (T)</a> &raquo;
<span class="title">TimeExt</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
</h1>
<dl class="box">
<dt class="r1 last">Defined in:</dt>
<dd class="r1 last">lib/time_ext.rb<span class="defines">,<br />
lib/time_ext/method_chain.rb</span>
</dd>
</dl>
<div class="clear"></div>
<h2>Defined Under Namespace</h2>
<p class="children">
<strong class="modules">Modules:</strong> <a href="TimeExt/Base.html" title="TimeExt::Base (module)">Base</a>, <a href="TimeExt/MethodChain.html" title="TimeExt::MethodChain (module)">MethodChain</a>
</p>
</div>
<div id="footer">
Generated on Thu Jul 29 04:27:16 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>

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>

View File

@@ -67,6 +67,36 @@
<td valign='top' width="33%">
<ul id="alpha_B" class="alpha">
<li class="letter">B</li>
<ul>
<li>
<a href="TimeExt/Base.html" title="TimeExt::Base (module)">Base</a>
<small>(TimeExt)</small>
</li>
</ul>
</ul>
<ul id="alpha_M" class="alpha">
<li class="letter">M</li>
<ul>
<li>
<a href="TimeExt/MethodChain.html" title="TimeExt::MethodChain (module)">MethodChain</a>
<small>(TimeExt)</small>
</li>
</ul>
</ul>
<ul id="alpha_T" class="alpha">
<li class="letter">T</li>
<ul>
@@ -76,6 +106,11 @@
</li>
<li>
<a href="TimeExt.html" title="TimeExt (module)">TimeExt</a>
</li>
</ul>
</ul>
@@ -85,7 +120,7 @@
</div></div>
<div id="footer">
Generated on Tue Jul 27 20:16:35 2010 by
Generated on Thu Jul 29 04:27:14 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>

View File

@@ -27,7 +27,7 @@
<ul id="full_list" class="class">
<li><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></li>
<li><a href="Time.html" title="Time (class)">Time</a> &lt; Object<small class='search_info'>Top Level Namespace</small></li>
<li><a href="Time.html" title="Time (class)">Time</a> &lt; Object<small class='search_info'>Top Level Namespace</small></li><li><a class='toggle'></a> <a href="TimeExt.html" title="TimeExt (module)">TimeExt</a><small class='search_info'>Top Level Namespace</small></li><ul><li><a href="TimeExt/Base.html" title="TimeExt::Base (module)">Base</a><small class='search_info'>TimeExt</small></li><li><a href="TimeExt/MethodChain.html" title="TimeExt::MethodChain (module)">MethodChain</a><small class='search_info'>TimeExt</small></li></ul>
</ul>
</div>

View File

@@ -96,7 +96,7 @@
<p>THE SOFTWARE IS PROVIDED &#8220;AS IS&#8221;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p></div></div>
<div id="footer">
Generated on Tue Jul 27 20:16:35 2010 by
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>

View File

@@ -96,7 +96,7 @@
<p>THE SOFTWARE IS PROVIDED &#8220;AS IS&#8221;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p></div></div>
<div id="footer">
Generated on Tue Jul 27 20:16:35 2010 by
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>

View File

@@ -28,6 +28,22 @@
<ul id="full_list" class="methods">
<li class="r1 ">
<a href="TimeExt/MethodChain.html#add_to_chain-instance_method" title="TimeExt::MethodChain#add_to_chain (method)">#add_to_chain</a>
<small>TimeExt::MethodChain</small>
</li>
<li class="r2 ">
<a href="Time.html#beginning_of_each-instance_method" title="Time#beginning_of_each (method)">#beginning_of_each</a>
<small>Time</small>
</li>
<li class="r1 ">
<a href="Time.html#beginning_of_hour-instance_method" title="Time#beginning_of_hour (method)">#beginning_of_hour</a>
@@ -53,6 +69,14 @@
<li class="r2 ">
<a href="TimeExt/MethodChain.html#call_chain-instance_method" title="TimeExt::MethodChain#call_chain (method)">#call_chain</a>
<small>TimeExt::MethodChain</small>
</li>
<li class="r1 ">
<a href="Time.html#ceil-instance_method" title="Time#ceil (method)">#ceil</a>
<small>Time</small>
@@ -60,7 +84,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<a href="Time.html#common_year_days_in_month-instance_method" title="Time#common_year_days_in_month (method)">#common_year_days_in_month</a>
<small>Time</small>
@@ -68,7 +92,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<a href="Time.html#days_ago-instance_method" title="Time#days_ago (method)">#days_ago</a>
<small>Time</small>
@@ -76,7 +100,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<a href="Time.html#days_into_week-instance_method" title="Time#days_into_week (method)">#days_into_week</a>
<small>Time</small>
@@ -84,7 +108,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<a href="Time.html#days_since-instance_method" title="Time#days_since (method)">#days_since</a>
<small>Time</small>
@@ -92,7 +116,23 @@
</li>
<li class="r2 ">
<a href="Time.html#each-instance_method" title="Time#each (method)">#each</a>
<small>Time</small>
</li>
<li class="r1 ">
<a href="Time.html#end_of-instance_method" title="Time#end_of (method)">#end_of</a>
<small>Time</small>
</li>
<li class="r2 ">
<a href="Time.html#end_of_hour-instance_method" title="Time#end_of_hour (method)">#end_of_hour</a>
<small>Time</small>
@@ -100,7 +140,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<a href="Time.html#end_of_minute-instance_method" title="Time#end_of_minute (method)">#end_of_minute</a>
<small>Time</small>
@@ -108,7 +148,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<a href="Time.html#end_of_second-instance_method" title="Time#end_of_second (method)">#end_of_second</a>
<small>Time</small>
@@ -116,7 +156,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<a href="Time.html#floor-instance_method" title="Time#floor (method)">#floor</a>
<small>Time</small>
@@ -124,7 +164,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<a href="Time.html#hours_ago-instance_method" title="Time#hours_ago (method)">#hours_ago</a>
<small>Time</small>
@@ -132,7 +172,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<a href="Time.html#hours_since-instance_method" title="Time#hours_since (method)">#hours_since</a>
<small>Time</small>
@@ -140,6 +180,30 @@
</li>
<li class="r2 ">
<a href="Time.html#iterate-instance_method" title="Time#iterate (method)">#iterate</a>
<small>Time</small>
</li>
<li class="r1 ">
<a href="Time.html#map_beginning_of_each-instance_method" title="Time#map_beginning_of_each (method)">#map_beginning_of_each</a>
<small>Time</small>
</li>
<li class="r2 ">
<a href="Time.html#map_each-instance_method" title="Time#map_each (method)">#map_each</a>
<small>Time</small>
</li>
<li class="r1 ">
<a href="Time.html#minutes_ago-instance_method" title="Time#minutes_ago (method)">#minutes_ago</a>
@@ -157,6 +221,14 @@
<li class="r1 ">
<a href="Time.html#next-instance_method" title="Time#next (method)">#next</a>
<small>Time</small>
</li>
<li class="r2 ">
<a href="Time.html#next_day-instance_method" title="Time#next_day (method)">#next_day</a>
<small>Time</small>
@@ -164,7 +236,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<a href="Time.html#next_hour-instance_method" title="Time#next_hour (method)">#next_hour</a>
<small>Time</small>
@@ -172,7 +244,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<a href="Time.html#next_minute-instance_method" title="Time#next_minute (method)">#next_minute</a>
<small>Time</small>
@@ -180,7 +252,7 @@
</li>
<li class="r2 ">
<li class="r1 ">
<a href="Time.html#next_quarter-instance_method" title="Time#next_quarter (method)">#next_quarter</a>
<small>Time</small>
@@ -188,7 +260,7 @@
</li>
<li class="r1 ">
<li class="r2 ">
<a href="Time.html#next_second-instance_method" title="Time#next_second (method)">#next_second</a>
<small>Time</small>
@@ -196,6 +268,14 @@
</li>
<li class="r1 ">
<a href="Time.html#prev-instance_method" title="Time#prev (method)">#prev</a>
<small>Time</small>
</li>
<li class="r2 ">
<a href="Time.html#prev_day-instance_method" title="Time#prev_day (method)">#prev_day</a>
@@ -269,7 +349,7 @@
<li class="r1 ">
<a href="Time.html#weeks_ago-instance_method" title="Time#weeks_ago (method)">#weeks_ago</a>
<a href="Time.html#until-instance_method" title="Time#until (method)">#until</a>
<small>Time</small>
@@ -277,6 +357,14 @@
<li class="r2 ">
<a href="Time.html#weeks_ago-instance_method" title="Time#weeks_ago (method)">#weeks_ago</a>
<small>Time</small>
</li>
<li class="r1 ">
<a href="Time.html#weeks_since-instance_method" title="Time#weeks_since (method)">#weeks_since</a>
<small>Time</small>

View File

@@ -65,6 +65,8 @@
<p class="children">
<strong class="modules">Modules:</strong> <a href="TimeExt.html" title="TimeExt (module)">TimeExt</a>
<strong class="classes">Classes:</strong> <a href="Time.html" title="Time (class)">Time</a>
@@ -79,7 +81,7 @@
</div>
<div id="footer">
Generated on Tue Jul 27 20:16:37 2010 by
Generated on Thu Jul 29 04:27:16 2010 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
0.5.8 (ruby-1.8.7).
</div>