Skip to content

Commit 2983db9

Browse files
committed
Update docs
1 parent 20f6ec3 commit 2983db9

File tree

4 files changed

+31
-47
lines changed

4 files changed

+31
-47
lines changed

docs-src/commands.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ IWrite Line(string val);
170170
```
171171

172172
```csharp
173-
public CommandResult Run()
173+
public override CommandResult Run()
174174
{
175175
Info("Display some information");
176176
}
@@ -197,7 +197,7 @@ Line("This is a plain line.");
197197
The **InEngine.Core.AbstractCommand** class provides a Logger property. It implements the **NLog.ILogger** interface.
198198

199199
```csharp
200-
public CommandResult Run()
200+
public override CommandResult Run()
201201
{
202202
Logger.Trace("Sample trace message");
203203
Logger.Debug("Sample debug message");
@@ -233,28 +233,20 @@ Setup an [NLog configuration](https://github.com/NLog/NLog/wiki/Tutorial#configu
233233
The **InEngine.Core.AbstractCommand** class provides a ProgressBar property. This is how it is used.
234234

235235
```csharp
236-
using InEngine.Core;
237-
238-
namespace MyCommandPlugin
236+
public override CommandResult Run()
239237
{
240-
public class MyCommand : AbstractCommand
241-
{
242-
public override CommandResult Run()
243-
{
244-
// Define the ticks (aka steps) for the command...
245-
var maxTicks = 100000;
246-
SetProgressBarMaxTicks(maxTicks);
238+
// Define the ticks (aka steps) for the command...
239+
var maxTicks = 100000;
240+
SetProgressBarMaxTicks(maxTicks);
247241

248-
// Do some work...
249-
for (var i = 0; i <= maxTicks;i++)
250-
{
251-
// Update the command's progress
252-
UpdateProgress(i);
253-
}
254-
255-
return new CommandResult(true);
256-
}
242+
// Do some work...
243+
for (var i = 0; i <= maxTicks;i++)
244+
{
245+
// Update the command's progress
246+
UpdateProgress(i);
257247
}
248+
249+
return new CommandResult(true);
258250
}
259251
```
260252

docs/commands/index.html

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ <h2 id="writing-output">Writing Output</h2>
245245
IWrite Line(string val);
246246
</code></pre>
247247

248-
<pre><code class="csharp">public CommandResult Run()
248+
<pre><code class="csharp">public override CommandResult Run()
249249
{
250250
Info(&quot;Display some information&quot;);
251251
}
@@ -264,7 +264,7 @@ <h2 id="writing-output">Writing Output</h2>
264264
Line("This is a plain line.");</p>
265265
<h2 id="logging">Logging</h2>
266266
<p>The <strong>InEngine.Core.AbstractCommand</strong> class provides a Logger property. It implements the <strong>NLog.ILogger</strong> interface.</p>
267-
<pre><code class="csharp">public CommandResult Run()
267+
<pre><code class="csharp">public override CommandResult Run()
268268
{
269269
Logger.Trace(&quot;Sample trace message&quot;);
270270
Logger.Debug(&quot;Sample debug message&quot;);
@@ -295,28 +295,20 @@ <h2 id="logging">Logging</h2>
295295

296296
<h2 id="progress-bar">Progress Bar</h2>
297297
<p>The <strong>InEngine.Core.AbstractCommand</strong> class provides a ProgressBar property. This is how it is used.</p>
298-
<pre><code class="csharp">using InEngine.Core;
299-
300-
namespace MyCommandPlugin
298+
<pre><code class="csharp">public override CommandResult Run()
301299
{
302-
public class MyCommand : AbstractCommand
303-
{
304-
public override CommandResult Run()
305-
{
306-
// Define the ticks (aka steps) for the command...
307-
var maxTicks = 100000;
308-
SetProgressBarMaxTicks(maxTicks);
309-
310-
// Do some work...
311-
for (var i = 0; i &lt;= maxTicks;i++)
312-
{
313-
// Update the command's progress
314-
UpdateProgress(i);
315-
}
300+
// Define the ticks (aka steps) for the command...
301+
var maxTicks = 100000;
302+
SetProgressBarMaxTicks(maxTicks);
316303

317-
return new CommandResult(true);
318-
}
304+
// Do some work...
305+
for (var i = 0; i &lt;= maxTicks;i++)
306+
{
307+
// Update the command's progress
308+
UpdateProgress(i);
319309
}
310+
311+
return new CommandResult(true);
320312
}
321313
</code></pre></div>
322314
</div>

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,5 +146,5 @@ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
146146

147147
<!--
148148
MkDocs version : 0.16.3
149-
Build Date UTC : 2017-11-22 03:34:27
149+
Build Date UTC : 2017-11-22 03:36:04
150150
-->

0 commit comments

Comments
 (0)