FlightControl-Master/MOOSE
1
0
Fork 0
mirror of https://github.com/FlightControl-Master/MOOSE.git synced 2025-10-29 16:58:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added documentation in SPAWN

Browse Source 
-- Added documentation for methods GetFirstAliveGroup,
GetNextAliveGroup, GetLastAliveGroup.
-- Added code snippets to the documentation for the methods
GetFirstAliveGroup, GetNextAliveGroup, GetLastAliveGroup.
This commit is contained in:
Sven Van de Velde
2016-07-29 08:22:57 +02:00
parent 54ff64aa94
commit daef3e415f
9 changed files with 184 additions and 1843 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
Moose Training/Documentation/Scheduler.html
View File

@@ -176,7 +176,7 @@
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SCHEDULER).Schedule">SCHEDULER:Schedule(TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds)</a></td>
<td class="name" nowrap="nowrap"><a href="##(SCHEDULER).Schedule">SCHEDULER:Schedule(TimeEventObject, TimeEventFunction, TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds)</a></td>
<td class="summary">
<p>Schedule a new time event.</p>
</td>
@@ -215,12 +215,24 @@
<td class="name" nowrap="nowrap"><a href="##(SCHEDULER).StopSeconds">SCHEDULER.StopSeconds</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SCHEDULER).TimeEventFunction">SCHEDULER.TimeEventFunction</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SCHEDULER).TimeEventFunctionArguments">SCHEDULER.TimeEventFunctionArguments</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(SCHEDULER).TimeEventObject">SCHEDULER.TimeEventObject</a></td>
<td class="summary">
</td>
</tr>
<tr>
@@ -374,7 +386,7 @@ self</p>
<dt>
<a id="#(SCHEDULER).Schedule" >
<strong>SCHEDULER:Schedule(TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds)</strong>
<strong>SCHEDULER:Schedule(TimeEventObject, TimeEventFunction, TimeEventFunctionArguments, StartSeconds, RepeatSecondsInterval, RandomizationFactor, StopSeconds)</strong>
</a>
</dt>
<dd>
@@ -388,6 +400,18 @@ self</p>
<ul>
<li>
<p><code><em>#table TimeEventObject </em></code>:
Specified for which Moose object the timer is setup. If a value of nil is provided, a scheduler will be setup without an object reference.</p>
</li>
<li>
<p><code><em>#function TimeEventFunction </em></code>:
The event function to be called when a timer event occurs. The event function needs to accept the parameters specified in TimeEventFunctionArguments.</p>
</li>
<li>
<p><code><em>#table TimeEventFunctionArguments </em></code>:
Optional arguments that can be given as part of scheduler. The arguments need to be given as a table { param1, param 2, ... }.</p>
@@ -514,6 +538,20 @@ self</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(SCHEDULER).TimeEventFunction" >
<strong>SCHEDULER.TimeEventFunction</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">
@@ -528,6 +566,20 @@ self</p>
</dd>
</dl>
<dl class="function">
<dt>
<em></em>
<a id="#(SCHEDULER).TimeEventObject" >
<strong>SCHEDULER.TimeEventObject</strong>
</a>
</dt>
<dd>
</dd>
</dl>
<dl class="function">