doc/StandupMD/Config/Cli.html in standup_md-0.3.2 vs doc/StandupMD/Config/Cli.html in standup_md-0.3.3
- old
+ new
@@ -101,12 +101,28 @@
+ <section class="constants-list">
+ <header>
+ <h3>Constants</h3>
+ </header>
+ <dl>
+
+ <dt id="DEFAULTS">DEFAULTS
+
+ <dd><p>The default options.</p>
+<p>@return [Hash]</p>
+
+
+ </dl>
+ </section>
+
+
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
@@ -134,11 +150,11 @@
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
- <p>The date to use to find the file.</p>
+ <p>The date to use to find the entry.</p>
<p>@param [Date] date</p>
<p>@return [Date]</p>
@@ -202,11 +218,11 @@
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
- <p>Should the cli print the entry?</p>
+ <p>Should the cli print the entry to the command line?</p>
<p>@param [Boolean] print</p>
<p>@return [Boolean]</p>
@@ -236,11 +252,11 @@
class="attribute-access-type">[RW]</span>
</div>
<div class="method-description">
- <p>Should the cli write the file?</p>
+ <p>Should the cli automatically write the new entry to the file?</p>
<p>@param [Boolean] write</p>
<p>@return [Boolean]</p>
@@ -274,11 +290,11 @@
<div class="method-source-code" id="new-source">
- <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 78</span>
+ <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 95</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
<span class="ruby-identifier">reset</span>
<span class="ruby-keyword">end</span></pre>
</div>
@@ -311,25 +327,18 @@
<div class="method-description">
<p>Sets all config values back to their defaults.</p>
-<p>@return [Boolean] true if successful</p>
+<p>@return [Hash]</p>
<div class="method-source-code" id="reset-source">
- <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 86</span>
+ <pre><span class="ruby-comment"># File lib/standup_md/config/cli.rb, line 103</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">reset</span>
- <span class="ruby-ivar">@date</span> = <span class="ruby-constant">Date</span>.<span class="ruby-identifier">today</span>
- <span class="ruby-ivar">@editor</span> = <span class="ruby-identifier">set_editor</span>
- <span class="ruby-ivar">@verbose</span> = <span class="ruby-keyword">false</span>
- <span class="ruby-ivar">@edit</span> = <span class="ruby-keyword">true</span>
- <span class="ruby-ivar">@write</span> = <span class="ruby-keyword">true</span>
- <span class="ruby-ivar">@print</span> = <span class="ruby-keyword">false</span>
- <span class="ruby-ivar">@auto_fill_previous</span> = <span class="ruby-keyword">true</span>
- <span class="ruby-ivar">@preference_file</span> = <span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">expand_path</span>(<span class="ruby-operator">::</span><span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">ENV</span>[<span class="ruby-string">'HOME'</span>], <span class="ruby-string">'.standuprc'</span>))
+ <span class="ruby-constant">DEFAULTS</span>.<span class="ruby-identifier">each</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">instance_variable_set</span>(<span class="ruby-node">"@#{k}"</span>, <span class="ruby-identifier">v</span>) }
<span class="ruby-keyword">end</span></pre>
</div>
</div>