Skip to content

Commit

Permalink
RDoc updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
geoffharcourt committed Mar 13, 2012
1 parent 9abd3be commit cb42c3b
Show file tree
Hide file tree
Showing 9 changed files with 1,146 additions and 71 deletions.
110 changes: 109 additions & 1 deletion doc/Greenmonster.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,32 @@ <h3 class="section-header">Defined In</h3>



<!-- Method Quickref -->
<nav id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>

<ul class="link-list">

<li><a href="#method-c-games_folder">::games_folder</a>

<li><a href="#method-c-set_games_folder">::set_games_folder</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="./Rakefile.html">Rakefile</a>

</ul>
</nav>

<nav id="classindex-section" class="section project-section">
<h3 class="section-header">Class and Module Index</h3>

Expand All @@ -72,6 +93,10 @@ <h3 class="section-header">Class and Module Index</h3>

<li><a href="./Greenmonster/Spider.html">Greenmonster::Spider</a>

<li><a href="./GreenmonsterSpiderTest.html">GreenmonsterSpiderTest</a>

<li><a href="./GreenmonsterTest.html">GreenmonsterTest</a>

</ul>
</nav>

Expand Down Expand Up @@ -99,6 +124,89 @@ <h1 class="module">module Greenmonster</h1>

<!-- Methods -->

<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
<h3 class="section-header">Public Class Methods</h3>


<div id="method-c-games_folder" class="method-detail ">

<div class="method-heading">
<span class="method-name">games_folder</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>


<div class="method-description">

<p>Return the default games folder location</p>

<p>Example:</p>

<pre class="ruby"><span class="ruby-operator">&gt;&gt;</span> <span class="ruby-constant">Greenmonster</span>.<span class="ruby-identifier">set_games_folder</span>(<span class="ruby-string">&quot;/Users/geoff/game_data&quot;</span>)
<span class="ruby-operator">&gt;&gt;</span> <span class="ruby-constant">Greenmonster</span>.<span class="ruby-identifier">games_folder</span>
=<span class="ruby-operator">&gt;</span> <span class="ruby-string">&quot;/Users/geoff/game_data&quot;</span>
</pre>



<div class="method-source-code" id="games_folder-source">
<pre><span class="ruby-comment"># File lib/greenmonster.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">games_folder</span>
<span class="ruby-identifier">@@games_folder</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- games_folder-source -->

</div>




</div><!-- games_folder-method -->


<div id="method-c-set_games_folder" class="method-detail ">

<div class="method-heading">
<span class="method-name">set_games_folder</span><span
class="method-args">(location)</span>
<span class="method-click-advice">click to toggle source</span>
</div>


<div class="method-description">

<p>Set the default folder to which games are saved after being downloaded from
the server.</p>

<p>Example:</p>

<pre class="ruby">=<span class="ruby-operator">&gt;</span> <span class="ruby-constant">Greenmonster</span>.<span class="ruby-identifier">set_games_folder</span>(<span class="ruby-string">&quot;/Users/geoff/game_data&quot;</span>)
</pre>

<p>Arguments:</p>

<pre>location: (String)</pre>



<div class="method-source-code" id="set_games_folder-source">
<pre><span class="ruby-comment"># File lib/greenmonster.rb, line 20</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">set_games_folder</span>(<span class="ruby-identifier">location</span>)
<span class="ruby-identifier">@@games_folder</span> = <span class="ruby-identifier">location</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- set_games_folder-source -->

</div>




</div><!-- set_games_folder-method -->


</section><!-- public-class-method-details -->

</section><!-- 5Buntitled-5D -->

</div><!-- documentation -->
Expand Down
188 changes: 123 additions & 65 deletions doc/Greenmonster/Spider.html

Large diffs are not rendered by default.

Loading

0 comments on commit cb42c3b

Please sign in to comment.