Documentation Update

This commit is contained in:
Grey-Echo
2017-04-22 11:35:14 +02:00
parent 28380a5c37
commit fb6bb635c6
9 changed files with 653 additions and 30 deletions

View File

@@ -138,15 +138,21 @@
<h2><a id="#(SPOT)">Type <code>SPOT</code></a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).ClassName">SPOT.ClassName</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).IsLasing">SPOT:IsLasing()</a></td>
<td class="summary">
<p>Check if the SPOT is lasing</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).LaseOff">SPOT:LaseOff()</a></td>
<td class="summary">
<p>LaseOff Trigger for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).LaseOn">SPOT:LaseOn()</a></td>
<td class="summary">
<p>LaseOn Trigger for SPOT</p>
</td>
</tr>
<tr>
@@ -165,6 +171,36 @@
<td class="name" nowrap="nowrap"><a href="##(SPOT).New">SPOT:New(Recce, LaserCode, Duration)</a></td>
<td class="summary">
<p>SPOT Constructor.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnAfterLaseOff">SPOT:OnAfterLaseOff(From, Event, To)</a></td>
<td class="summary">
<p>LaseOff Handler OnAfter for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnAfterLaseOn">SPOT:OnAfterLaseOn(From, Event, To)</a></td>
<td class="summary">
<p>LaseOn Handler OnAfter for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnBeforeLaseOff">SPOT:OnBeforeLaseOff(From, Event, To)</a></td>
<td class="summary">
<p>LaseOff Handler OnBefore for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnBeforeLaseOn">SPOT:OnBeforeLaseOn(From, Event, To)</a></td>
<td class="summary">
<p>LaseOn Handler OnBefore for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).OnEventDead">SPOT:OnEventDead(EventData)</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -189,6 +225,18 @@
<td class="name" nowrap="nowrap"><a href="##(SPOT).Target">SPOT.Target</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).__LaseOff">SPOT:__LaseOff(Delay)</a></td>
<td class="summary">
<p>LaseOff Asynchronous Trigger for SPOT</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SPOT).__LaseOn">SPOT:__LaseOn(Delay)</a></td>
<td class="summary">
<p>LaseOn Asynchronous Trigger for SPOT</p>
</td>
</tr>
<tr>
@@ -233,20 +281,6 @@
<dl class="function">
<dt>
<em>#string</em>
<a id="#(SPOT).ClassName" >
<strong>SPOT.ClassName</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).IsLasing" >
<strong>SPOT:IsLasing()</strong>
</a>
@@ -260,6 +294,32 @@
<p><em>#boolean:</em>
true if it is lasing</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).LaseOff" >
<strong>SPOT:LaseOff()</strong>
</a>
</dt>
<dd>
<p>LaseOff Trigger for SPOT</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).LaseOn" >
<strong>SPOT:LaseOn()</strong>
</a>
</dt>
<dd>
<p>LaseOn Trigger for SPOT</p>
</dd>
</dl>
<dl class="function">
@@ -324,6 +384,161 @@ true if it is lasing</p>
<p><em><a href="##(SPOT)">#SPOT</a>:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnAfterLaseOff" >
<strong>SPOT:OnAfterLaseOff(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>LaseOff Handler OnAfter for SPOT</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnAfterLaseOn" >
<strong>SPOT:OnAfterLaseOn(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>LaseOn Handler OnAfter for SPOT</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnBeforeLaseOff" >
<strong>SPOT:OnBeforeLaseOff(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>LaseOff Handler OnBefore for SPOT</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnBeforeLaseOn" >
<strong>SPOT:OnBeforeLaseOn(From, Event, To)</strong>
</a>
</dt>
<dd>
<p>LaseOn Handler OnBefore for SPOT</p>
<h3>Parameters</h3>
<ul>
<li>
<p><code><em>#string From </em></code>: </p>
</li>
<li>
<p><code><em>#string Event </em></code>: </p>
</li>
<li>
<p><code><em>#string To </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em>#boolean:</em></p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).OnEventDead" >
<strong>SPOT:OnEventDead(EventData)</strong>
</a>
</dt>
<dd>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Core.Event.html##(EVENTDATA)">Core.Event#EVENTDATA</a> EventData </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
@@ -343,7 +558,6 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).ScheduleID" >
<strong>SPOT.ScheduleID</strong>
</a>
@@ -357,7 +571,6 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).Spot" >
<strong>SPOT.Spot</strong>
</a>
@@ -371,7 +584,6 @@ true if it is lasing</p>
<dl class="function">
<dt>
<em></em>
<a id="#(SPOT).Target" >
<strong>SPOT.Target</strong>
</a>
@@ -380,6 +592,48 @@ true if it is lasing</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).__LaseOff" >
<strong>SPOT:__LaseOff(Delay)</strong>
</a>
</dt>
<dd>
<p>LaseOff Asynchronous Trigger for SPOT</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(SPOT).__LaseOn" >
<strong>SPOT:__LaseOn(Delay)</strong>
</a>
</dt>
<dd>
<p>LaseOn Asynchronous Trigger for SPOT</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em>#number Delay </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">