Update YARD docs
This commit is contained in:
Bill Niblock
parent
119786aad6
commit
321ce557d8
18 changed files with 1554 additions and 517 deletions
175
doc/Gardner.html
175
doc/Gardner.html
|
|
@ -112,30 +112,6 @@
|
|||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#grow-class_method" title="grow (class method)">.<strong>grow</strong>(tree) ⇒ Hash </a>
|
||||
|
||||
|
||||
|
||||
</span>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>The main method for Sapling.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
||||
|
||||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#prune_branches-class_method" title="prune_branches (class method)">.<strong>prune_branches</strong>(tree) ⇒ Array </a>
|
||||
|
||||
|
||||
|
|
@ -151,7 +127,8 @@
|
|||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Parse the branch.</p>
|
||||
<p>Parse the tree array into an array of numbered branches, and ordered
|
||||
leaves.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
|
@ -175,7 +152,7 @@
|
|||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Parse the options.</p>
|
||||
<p>Parse the leaves of a branch into a numbered hash of options.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
|
@ -184,7 +161,7 @@
|
|||
<li class="public ">
|
||||
<span class="summary_signature">
|
||||
|
||||
<a href="#prune_trunk-class_method" title="prune_trunk (class method)">.<strong>prune_trunk</strong>(tree) ⇒ Hash </a>
|
||||
<a href="#prune_trunk-class_method" title="prune_trunk (class method)">.<strong>prune_trunk</strong>(tree) ⇒ Array </a>
|
||||
|
||||
|
||||
|
||||
|
|
@ -199,7 +176,7 @@
|
|||
|
||||
|
||||
<span class="summary_desc"><div class='inline'>
|
||||
<p>Parse the trunk The trunk is like the introduction to the tree.</p>
|
||||
<p>Parse the trunk of the tree.</p>
|
||||
</div></span>
|
||||
|
||||
</li>
|
||||
|
|
@ -215,92 +192,7 @@
|
|||
|
||||
|
||||
<div class="method_details first">
|
||||
<h3 class="signature first" id="grow-class_method">
|
||||
|
||||
.<strong>grow</strong>(tree) ⇒ <tt>Hash</tt>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>The main method for Sapling. From here, the tree is grown.</p>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="tags">
|
||||
<p class="tag_title">Parameters:</p>
|
||||
<ul class="param">
|
||||
|
||||
<li>
|
||||
|
||||
<span class='name'>tree</span>
|
||||
|
||||
|
||||
<span class='type'>(<tt>File</tt>)</span>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>The dialogue tree file</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
<p class="tag_title">Returns:</p>
|
||||
<ul class="return">
|
||||
|
||||
<li>
|
||||
|
||||
|
||||
<span class='type'>(<tt>Hash</tt>)</span>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>The final, constructed data set</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
|
||||
</div><table class="source_code">
|
||||
<tr>
|
||||
<td>
|
||||
<pre class="lines">
|
||||
|
||||
|
||||
61
|
||||
62
|
||||
63
|
||||
64
|
||||
65
|
||||
66</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 61</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_grow'>grow</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_trunk'>trunk</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Gardner (module)">Gardner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_prune_trunk'><span class='object_link'><a href="#prune_trunk-class_method" title="Gardner.prune_trunk (method)">prune_trunk</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_branches'>branches</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Gardner (module)">Gardner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_prune_branches'><span class='object_link'><a href="#prune_branches-class_method" title="Gardner.prune_branches (method)">prune_branches</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_trunk'>trunk</span><span class='rparen'>)</span>
|
||||
|
||||
<span class='kw'>return</span> <span class='id identifier rubyid_branches'>branches</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="method_details ">
|
||||
<h3 class="signature " id="prune_branches-class_method">
|
||||
<h3 class="signature first" id="prune_branches-class_method">
|
||||
|
||||
.<strong>prune_branches</strong>(tree) ⇒ <tt>Array</tt>
|
||||
|
||||
|
|
@ -311,7 +203,8 @@
|
|||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Parse the branch</p>
|
||||
<p>Parse the tree array into an array of numbered branches, and ordered
|
||||
leaves.</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
|
@ -350,7 +243,7 @@
|
|||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>The array of options on the branch.</p>
|
||||
<p>An array of numbered branches, with numbered leaves</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
|
@ -372,8 +265,7 @@
|
|||
16
|
||||
17
|
||||
18
|
||||
19
|
||||
20</pre>
|
||||
19</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 10</span>
|
||||
|
|
@ -387,7 +279,6 @@
|
|||
<span class='kw'>end</span>
|
||||
|
||||
<span class='kw'>return</span> <span class='id identifier rubyid_branches'>branches</span>
|
||||
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -406,7 +297,7 @@
|
|||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Parse the options</p>
|
||||
<p>Parse the leaves of a branch into a numbered hash of options.</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
|
@ -445,7 +336,7 @@
|
|||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>A has of options</p>
|
||||
<p>A numbered hash of options</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
|
@ -458,6 +349,7 @@
|
|||
<pre class="lines">
|
||||
|
||||
|
||||
25
|
||||
26
|
||||
27
|
||||
28
|
||||
|
|
@ -469,12 +361,10 @@
|
|||
34
|
||||
35
|
||||
36
|
||||
37
|
||||
38
|
||||
39</pre>
|
||||
37</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 26</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 25</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_prune_leaves'>prune_leaves</span><span class='lparen'>(</span><span class='id identifier rubyid_leaves'>leaves</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='int'>1</span>
|
||||
|
|
@ -488,7 +378,6 @@
|
|||
<span class='kw'>end</span>
|
||||
|
||||
<span class='kw'>return</span> <span class='id identifier rubyid_options'>options</span>
|
||||
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -498,7 +387,7 @@
|
|||
<div class="method_details ">
|
||||
<h3 class="signature " id="prune_trunk-class_method">
|
||||
|
||||
.<strong>prune_trunk</strong>(tree) ⇒ <tt>Hash</tt>
|
||||
.<strong>prune_trunk</strong>(tree) ⇒ <tt>Array</tt>
|
||||
|
||||
|
||||
|
||||
|
|
@ -507,7 +396,7 @@
|
|||
</h3><div class="docstring">
|
||||
<div class="discussion">
|
||||
|
||||
<p>Parse the trunk The trunk is like the introduction to the tree.</p>
|
||||
<p>Parse the trunk of the tree.</p>
|
||||
|
||||
|
||||
</div>
|
||||
|
|
@ -540,13 +429,13 @@
|
|||
<li>
|
||||
|
||||
|
||||
<span class='type'>(<tt>Hash</tt>)</span>
|
||||
<span class='type'>(<tt>Array</tt>)</span>
|
||||
|
||||
|
||||
|
||||
—
|
||||
<div class='inline'>
|
||||
<p>The tree without the trunk</p>
|
||||
<p>The trunk, and the remainder of the tree</p>
|
||||
</div>
|
||||
|
||||
</li>
|
||||
|
|
@ -559,29 +448,19 @@
|
|||
<pre class="lines">
|
||||
|
||||
|
||||
43
|
||||
44
|
||||
45
|
||||
46
|
||||
47
|
||||
48
|
||||
49
|
||||
50
|
||||
51
|
||||
52
|
||||
53
|
||||
54
|
||||
55</pre>
|
||||
47</pre>
|
||||
</td>
|
||||
<td>
|
||||
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 46</span>
|
||||
<pre class="code"><span class="info file"># File 'lib/sapling/gardner.rb', line 43</span>
|
||||
|
||||
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_prune_trunk'>prune_trunk</span><span class='lparen'>(</span><span class='id identifier rubyid_tree'>tree</span><span class='rparen'>)</span>
|
||||
<span class='id identifier rubyid_trunk'>trunk</span> <span class='op'>=</span> <span class='id identifier rubyid_tree'>tree</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span>
|
||||
<span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_trunk'>trunk</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>trunk</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
||||
<span class='int'>40</span><span class='period'>.</span><span class='id identifier rubyid_times'>times</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>-</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>
|
||||
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>\n</span><span class='tstring_end'>"</span></span>
|
||||
|
||||
<span class='kw'>return</span> <span class='id identifier rubyid_tree'>tree</span>
|
||||
|
||||
<span class='kw'>return</span> <span class='lbracket'>[</span><span class='id identifier rubyid_trunk'>trunk</span><span class='comma'>,</span><span class='id identifier rubyid_tree'>tree</span><span class='rbracket'>]</span>
|
||||
<span class='kw'>end</span></pre>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -593,9 +472,9 @@
|
|||
</div>
|
||||
|
||||
<div id="footer">
|
||||
Generated on Sun May 7 16:58:49 2017 by
|
||||
Generated on Sat Oct 14 23:40:01 2017 by
|
||||
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
||||
0.9.9 (ruby-2.2.5).
|
||||
0.9.9 (ruby-2.4.2).
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue