Skip to content

Commit 1403eb5

Browse files
committed
Update docs and bump version
1 parent 1b9e431 commit 1403eb5

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

docs/commands/index.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -501,10 +501,10 @@ <h2 id="create-a-command">Create a Command<a class="headerlink" href="#create-a-
501501
<span class="p">{</span>
502502
<span class="k">public</span> <span class="k">class</span> <span class="nc">MyCommand</span> <span class="p">:</span> <span class="n">ICommand</span>
503503
<span class="p">{</span>
504-
<span class="k">public</span> <span class="n">CommandResult</span> <span class="nf">Run</span><span class="p">()</span>
504+
<span class="k">public</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
505505
<span class="p">{</span>
506506
<span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">&quot;Hello, world!&quot;</span><span class="p">);</span>
507-
<span class="k">return</span> <span class="k">new</span> <span class="nf">CommandResult</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
507+
<span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
508508
<span class="p">}</span>
509509
<span class="p">}</span>
510510
<span class="p">}</span>
@@ -520,10 +520,10 @@ <h2 id="create-a-command">Create a Command<a class="headerlink" href="#create-a-
520520
<span class="p">{</span>
521521
<span class="k">public</span> <span class="k">class</span> <span class="nc">MyCommand</span> <span class="p">:</span> <span class="n">AbstractCommand</span>
522522
<span class="p">{</span>
523-
<span class="k">public</span> <span class="k">override</span> <span class="n">CommandResult</span> <span class="nf">Run</span><span class="p">()</span>
523+
<span class="k">public</span> <span class="k">override</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
524524
<span class="p">{</span>
525525
<span class="n">Console</span><span class="p">.</span><span class="n">WriteLine</span><span class="p">(</span><span class="s">&quot;Hello, world!&quot;</span><span class="p">);</span>
526-
<span class="k">return</span> <span class="k">new</span> <span class="nf">CommandResult</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
526+
<span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
527527
<span class="p">}</span>
528528
<span class="p">}</span>
529529
<span class="p">}</span>
@@ -633,7 +633,7 @@ <h2 id="writing-output">Writing Output<a class="headerlink" href="#writing-outpu
633633
</pre></div>
634634

635635

636-
<div class="codehilite"><pre><span></span><span class="k">public</span> <span class="k">override</span> <span class="n">CommandResult</span> <span class="nf">Run</span><span class="p">()</span>
636+
<div class="codehilite"><pre><span></span><span class="k">public</span> <span class="k">override</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
637637
<span class="p">{</span>
638638
<span class="n">Info</span><span class="p">(</span><span class="s">&quot;Display some information&quot;</span><span class="p">);</span>
639639
<span class="p">}</span>
@@ -655,15 +655,15 @@ <h2 id="writing-output">Writing Output<a class="headerlink" href="#writing-outpu
655655
Line("This is a plain line.");</p>
656656
<h2 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent link">&para;</a></h2>
657657
<p>The <strong>InEngine.Core.AbstractCommand</strong> class provides a Logger property. It implements the <strong>NLog.ILogger</strong> interface.</p>
658-
<div class="codehilite"><pre><span></span><span class="k">public</span> <span class="k">override</span> <span class="n">CommandResult</span> <span class="nf">Run</span><span class="p">()</span>
658+
<div class="codehilite"><pre><span></span><span class="k">public</span> <span class="k">override</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
659659
<span class="p">{</span>
660660
<span class="n">Logger</span><span class="p">.</span><span class="n">Trace</span><span class="p">(</span><span class="s">&quot;Sample trace message&quot;</span><span class="p">);</span>
661661
<span class="n">Logger</span><span class="p">.</span><span class="n">Debug</span><span class="p">(</span><span class="s">&quot;Sample debug message&quot;</span><span class="p">);</span>
662662
<span class="n">Logger</span><span class="p">.</span><span class="n">Info</span><span class="p">(</span><span class="s">&quot;Sample informational message&quot;</span><span class="p">);</span>
663663
<span class="n">Logger</span><span class="p">.</span><span class="n">Warn</span><span class="p">(</span><span class="s">&quot;Sample warning message&quot;</span><span class="p">);</span>
664664
<span class="n">Logger</span><span class="p">.</span><span class="n">Error</span><span class="p">(</span><span class="s">&quot;Sample error message&quot;</span><span class="p">);</span>
665665
<span class="n">Logger</span><span class="p">.</span><span class="n">Fatal</span><span class="p">(</span><span class="s">&quot;Sample fatal error message&quot;</span><span class="p">);</span>
666-
<span class="k">return</span> <span class="k">new</span> <span class="nf">CommandResult</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
666+
<span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
667667
<span class="p">}</span>
668668
</pre></div>
669669

@@ -688,7 +688,7 @@ <h2 id="logging">Logging<a class="headerlink" href="#logging" title="Permanent l
688688

689689
<h2 id="progress-bar">Progress Bar<a class="headerlink" href="#progress-bar" title="Permanent link">&para;</a></h2>
690690
<p>The <strong>InEngine.Core.AbstractCommand</strong> class provides a ProgressBar property. This is how it is used.</p>
691-
<div class="codehilite"><pre><span></span><span class="k">public</span> <span class="k">override</span> <span class="n">CommandResult</span> <span class="nf">Run</span><span class="p">()</span>
691+
<div class="codehilite"><pre><span></span><span class="k">public</span> <span class="k">override</span> <span class="k">void</span> <span class="nf">Run</span><span class="p">()</span>
692692
<span class="p">{</span>
693693
<span class="c1">// Define the ticks (aka steps) for the command...</span>
694694
<span class="kt">var</span> <span class="n">maxTicks</span> <span class="p">=</span> <span class="m">100000</span><span class="p">;</span>
@@ -701,7 +701,7 @@ <h2 id="progress-bar">Progress Bar<a class="headerlink" href="#progress-bar" tit
701701
<span class="n">UpdateProgress</span><span class="p">(</span><span class="n">i</span><span class="p">);</span>
702702
<span class="p">}</span>
703703

704-
<span class="k">return</span> <span class="k">new</span> <span class="nf">CommandResult</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
704+
<span class="k">return</span> <span class="k">new</span> <span class="nf">void</span><span class="p">(</span><span class="k">true</span><span class="p">);</span>
705705
<span class="p">}</span>
706706
</pre></div>
707707

0 commit comments

Comments
 (0)