Updated documentation

This commit is contained in:
FlightControl
2017-03-10 23:05:02 +01:00
parent d70d13449d
commit 8add761982
57 changed files with 3885 additions and 1693 deletions

View File

@@ -61,8 +61,8 @@
<li><a href="Static.html">Static</a></li>
<li>Task</li>
<li><a href="Task_A2G.html">Task_A2G</a></li>
<li><a href="Task_A2G_Dispatcher.html">Task_A2G_Dispatcher</a></li>
<li><a href="Task_PICKUP.html">Task_PICKUP</a></li>
<li><a href="Task_SEAD.html">Task_SEAD</a></li>
<li><a href="Unit.html">Unit</a></li>
<li><a href="Utils.html">Utils</a></li>
<li><a href="Zone.html">Zone</a></li>
@@ -237,6 +237,12 @@ Use the method <a href="##(TASK).AddScore">TASK.AddScore</a>() to add scores whe
<td class="name" nowrap="nowrap"><a href="##(TASK).GetScoring">TASK:GetScoring()</a></td>
<td class="summary">
<p>Gets the Scoring of the task</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).GetStateMachine">TASK:GetStateMachine(TaskUnit)</a></td>
<td class="summary">
<p>Gets the FiniteStateMachine of <a href="Task.html">Task</a> with key Task<a href="Unit.html">Unit</a></p>
</td>
</tr>
<tr>
@@ -264,7 +270,7 @@ Use the method <a href="##(TASK).AddScore">TASK.AddScore</a>() to add scores whe
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).GetUnitProcess">TASK:GetUnitProcess()</a></td>
<td class="name" nowrap="nowrap"><a href="##(TASK).GetUnitProcess">TASK:GetUnitProcess(TaskUnit)</a></td>
<td class="summary">
<p>Get the Task FSM Process Template</p>
</td>
@@ -354,9 +360,9 @@ Use the method <a href="##(TASK).AddScore">TASK.AddScore</a>() to add scores whe
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).MenuTaskStatus">TASK.MenuTaskStatus(MenuParam)</a></td>
<td class="name" nowrap="nowrap"><a href="##(TASK).MenuTaskStatus">TASK:MenuTaskStatus(TaskGroup)</a></td>
<td class="summary">
<p>Report the task status.</p>
</td>
</tr>
<tr>
@@ -609,12 +615,18 @@ Use the method <a href="##(TASK).AddScore">TASK.AddScore</a>() to add scores whe
<td class="name" nowrap="nowrap"><a href="##(TASK).TimeOut">TASK.TimeOut</a></td>
<td class="summary">
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).UnAssignFromGroup">TASK:UnAssignFromGroup(TaskGroup)</a></td>
<td class="summary">
<p>UnAssign the <a href="Task.html">Task</a> from a <a href="Group.html">Group</a>.</p>
</td>
</tr>
<tr>
<td class="name" nowrap="nowrap"><a href="##(TASK).UnAssignFromGroups">TASK:UnAssignFromGroups()</a></td>
<td class="summary">
<p>Assign the <a href="Task.html">Task</a> from the <a href="Group.html">Group</a>s.</p>
<p>UnAssign the <a href="Task.html">Task</a> from the <a href="Group.html">Group</a>s.</p>
</td>
</tr>
<tr>
@@ -1072,6 +1084,32 @@ The Task Name</p>
<p><em><a href="Functional.Scoring.html##(SCORING)">Functional.Scoring#SCORING</a>:</em>
Scoring</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK).GetStateMachine" >
<strong>TASK:GetStateMachine(TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Gets the FiniteStateMachine of <a href="Task.html">Task</a> with key Task<a href="Unit.html">Unit</a></p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em><a href="Wrapper.Unit.html##(UNIT)">Wrapper.Unit#UNIT</a> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a>:</em></p>
</dd>
</dl>
<dl class="function">
@@ -1145,13 +1183,21 @@ TaskType</p>
<dt>
<a id="#(TASK).GetUnitProcess" >
<strong>TASK:GetUnitProcess()</strong>
<strong>TASK:GetUnitProcess(TaskUnit)</strong>
</a>
</dt>
<dd>
<p>Get the Task FSM Process Template</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> TaskUnit </em></code>: </p>
</li>
</ul>
<h3>Return value</h3>
<p><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a>:</em></p>
@@ -1431,18 +1477,18 @@ true if Unit is part of the Task.</p>
<dt>
<a id="#(TASK).MenuTaskStatus" >
<strong>TASK.MenuTaskStatus(MenuParam)</strong>
<strong>TASK:MenuTaskStatus(TaskGroup)</strong>
</a>
</dt>
<dd>
<p>Report the task status.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> MenuParam </em></code>: </p>
<p><code><em> TaskGroup </em></code>: </p>
</li>
</ul>
@@ -2005,7 +2051,7 @@ self</p>
</li>
<li>
<p><code><em> Fsm </em></code>: </p>
<p><code><em><a href="Core.Fsm.html##(FSM_PROCESS)">Core.Fsm#FSM_PROCESS</a> Fsm </em></code>: </p>
</li>
</ul>
@@ -2270,6 +2316,27 @@ Fsm#FSM_PROCESS</p>
</dd>
</dl>
<dl class="function">
<dt>
<a id="#(TASK).UnAssignFromGroup" >
<strong>TASK:UnAssignFromGroup(TaskGroup)</strong>
</a>
</dt>
<dd>
<p>UnAssign the <a href="Task.html">Task</a> from a <a href="Group.html">Group</a>.</p>
<h3>Parameter</h3>
<ul>
<li>
<p><code><em> TaskGroup </em></code>: </p>
</li>
</ul>
</dd>
</dl>
<dl class="function">
@@ -2281,7 +2348,7 @@ Fsm#FSM_PROCESS</p>
</dt>
<dd>
<p>Assign the <a href="Task.html">Task</a> from the <a href="Group.html">Group</a>s.</p>
<p>UnAssign the <a href="Task.html">Task</a> from the <a href="Group.html">Group</a>s.</p>
</dd>
</dl>