doc/String.html in shenanigans-1.0.9 vs doc/String.html in shenanigans-1.0.10

- old
+ new

@@ -1,199 +1,226 @@ -<!DOCTYPE html> +<!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 http-equiv="Content-Type" content="text/html; charset=utf-8" /> +<title> + Class: String + + &mdash; Documentation by YARD 0.8.7.3 + +</title> -<html> -<head> -<meta content="text/html; charset=UTF-8" http-equiv="Content-Type"> + <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" /> -<title>class String - Shenanigans</title> + <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" /> -<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet"> - -<script type="text/javascript"> - var rdoc_rel_prefix = "./"; +<script type="text/javascript" charset="utf-8"> + hasFrames = window.top.frames.main ? true : false; + relpath = ''; + framesUrl = "frames.html#!" + escape(window.location.href); </script> -<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script> -<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script> -<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script> -<script type="text/javascript" charset="utf-8" src="./js/search.js"></script> -<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script> -<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script> + <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script> -<body id="top" class="class"> -<nav id="metadata"> - <nav id="home-section" class="section"> - <h3 class="section-header"> - <a href="./index.html">Home</a> - <a href="./table_of_contents.html#classes">Classes</a> - <a href="./table_of_contents.html#methods">Methods</a> - </h3> -</nav> + <script type="text/javascript" charset="utf-8" src="js/app.js"></script> - <nav id="search-section" class="section project-section" class="initially-hidden"> - <form action="#" method="get" accept-charset="utf-8"> - <h3 class="section-header"> - <input type="text" name="search" placeholder="Search" id="search-field" - title="Type to search, Up and Down to navigate, Enter to load"> - </h3> - </form> + </head> + <body> + <div id="header"> + <div id="menu"> + + <a href="_index.html">Index (S)</a> &raquo; + + + <span class="title">String</span> + - <ul id="search-results" class="initially-hidden"></ul> -</nav> + <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div> +</div> - + <div id="search"> + <a class="full_list_link" id="class_list_link" + href="class_list.html"> + Class List + </a> + + <a class="full_list_link" id="method_list_link" + href="method_list.html"> + Method List + </a> + + <a class="full_list_link" id="file_list_link" + href="file_list.html"> + File List + </a> + +</div> + <div class="clear"></div> + </div> - <div id="file-metadata"> - <nav id="file-list-section" class="section"> - <h3 class="section-header">Defined In</h3> - <ul> - <li>lib/shenanigans/string/in_groups_of.rb - </ul> -</nav> + <iframe id="search_frame"></iframe> - - </div> + <div id="content"><h1>Class: String + + + +</h1> - <div id="class-metadata"> +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></span> + + <ul class="fullTree"> + <li><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></li> + + <li class="next">String</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> - <nav id="parent-class-section" class="section"> - <h3 class="section-header">Parent</h3> - <p class="link"><a href="Object.html">Object</a> -</nav> - + - <!-- Method Quickref --> -<nav id="method-list-section" class="section"> - <h3 class="section-header">Methods</h3> + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/shenanigans/string/in_groups_of.rb</dd> + +</dl> +<div class="clear"></div> - <ul class="link-list"> - - <li ><a href="#method-i-in_groups_of">#in_groups_of</a> - - </ul> -</nav> - </div> - <div id="project-metadata"> - <nav id="fileindex-section" class="section project-section"> - <h3 class="section-header">Pages</h3> - <ul> + + + + - <li class="file"><a href="./README_rdoc.html">README</a> - - </ul> -</nav> + <h2> + Instance Method Summary + <small>(<a href="#" class="summary_toggle">collapse</a>)</small> + </h2> - <nav id="classindex-section" class="section project-section"> - <h3 class="section-header">Class and Module Index</h3> + <ul class="summary"> + + <li class="public "> + <span class="summary_signature"> + + <a href="#in_groups_of-instance_method" title="#in_groups_of (instance method)">- (Object) <strong>in_groups_of</strong>(size) </a> + - <ul class="link-list"> + + </span> - <li><a href="./Array.html">Array</a> - <li><a href="./Fixnum.html">Fixnum</a> - <li><a href="./Hash.html">Hash</a> - <li><a href="./Kernel.html">Kernel</a> - <li><a href="./Module.html">Module</a> - <li><a href="./Object.html">Object</a> - <li><a href="./String.html">String</a> - - </ul> -</nav> - </div> -</nav> - -<div id="documentation"> - <h1 class="class">class String</h1> - - <div id="description" class="description"> - - </div><!-- description --> - + <span class="summary_desc"><div class='inline'> +<p>Returns an array of the string broken down into groups of size characters.</p> +</div></span> +</li> + + + </ul> - <section id="5Buntitled-5D" class="documentation-section"> - - - - + <div id="instance_method_details" class="method_details_list"> + <h2>Instance Method Details</h2> - <!-- Methods --> - <section id="public-instance-5Buntitled-5D-method-details" class="method-section section"> - <h3 class="section-header">Public Instance Methods</h3> + <div class="method_details first"> + <h3 class="signature first" id="in_groups_of-instance_method"> + + - (<tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>) <strong>in_groups_of</strong>(size) + - - <div id="method-i-in_groups_of" class="method-detail "> - - <div class="method-heading"> - <span class="method-name">in_groups_of</span><span - class="method-args">(size)</span> - - <span class="method-click-advice">click to toggle source</span> - - </div> - + - <div class="method-description"> - - <p>Returns an array of the string broken down into groups of <code>size</code> + +</h3><div class="docstring"> + <div class="discussion"> + +<p>Returns an array of the string broken down into groups of <code>size</code> characters.</p> <pre class="ruby"><span class="ruby-string">&quot;aabbcc&quot;</span>.<span class="ruby-identifier">in_groups_of</span>(<span class="ruby-value">2</span>) <span class="ruby-comment">#=&gt; [&#39;aa&#39;, &#39;bb&#39;, &#39;cc&#39;]</span> <span class="ruby-string">&quot;&quot;</span>.<span class="ruby-identifier">in_groups_of</span>(<span class="ruby-value">2</span>) <span class="ruby-comment">#=&gt; []</span> <span class="ruby-string">&quot;&quot;</span>.<span class="ruby-identifier">in_groups_of</span>(<span class="ruby-value">0</span>) <span class="ruby-comment">#=&gt; ArgumentError</span> </pre> - - - - <div class="method-source-code" id="in_groups_of-source"> - <pre><span class="ruby-comment"># File lib/shenanigans/string/in_groups_of.rb, line 10</span> -<span class="ruby-keyword">def</span> <span class="ruby-identifier">in_groups_of</span>(<span class="ruby-identifier">size</span>) - <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;Size of group must be &gt;= 1&quot;</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">size</span> <span class="ruby-operator">&lt;</span> <span class="ruby-value">1</span> - <span class="ruby-identifier">scan</span>(<span class="ruby-node">/.{1,#{size}}/</span>) -<span class="ruby-keyword">end</span></pre> - </div><!-- in_groups_of-source --> - - </div> - + </div> +</div> +<div class="tags"> + +<p class="tag_title">Raises:</p> +<ul class="raise"> + + <li> + + + <span class='type'>(<tt>ArgumentError</tt>)</span> + + + + </li> + +</ul> - - </div><!-- in_groups_of-method --> +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> - - </section><!-- public-instance-method-details --> - - </section><!-- 5Buntitled-5D --> -</div><!-- documentation --> +10 +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/shenanigans/string/in_groups_of.rb', line 10</span> +<span class='kw'>def</span> <span class='id identifier rubyid_in_groups_of'>in_groups_of</span><span class='lparen'>(</span><span class='id identifier rubyid_size'>size</span><span class='rparen'>)</span> + <span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Size of group must be &gt;= 1</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_size'>size</span> <span class='op'>&lt;</span> <span class='int'>1</span> + <span class='id identifier rubyid_scan'>scan</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>.{1,</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_size'>size</span><span class='embexpr_end'>}</span><span class='tstring_content'>}</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> + </td> + </tr> +</table> +</div> + + </div> -<footer id="validator-badges"> - <p><a href="http://validator.w3.org/check/referer">[Validate]</a> - <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0. - <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3. -</footer> +</div> + <div id="footer"> + Generated on Tue Dec 31 15:41:29 2013 by + <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> + 0.8.7.3 (ruby-2.0.0). +</div> + + </body> +</html> \ No newline at end of file