MOOSE generated documentation [skip ci]

This commit is contained in:
Applevangelist
2023-04-04 08:48:33 +00:00
parent a77c94f7f0
commit da4fbf2f2d
26 changed files with 1118 additions and 599 deletions

View File

@@ -1740,6 +1740,12 @@ Moose refers to <strong>_DATABASE</strong> within the framework extensively, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).AddOpsGroup">DATABASE:AddOpsGroup(opsgroup)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Add an OPS group (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) to the data base.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).AddOpsZone">DATABASE:AddOpsZone(OpsZone)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Adds a <a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a> based on the zone name in the DATABASE.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1800,6 +1806,12 @@ Moose refers to <strong>_DATABASE</strong> within the framework extensively, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).DeleteCargo">DATABASE:DeleteCargo(CargoName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Deletes a Cargo from the DATABASE based on the Cargo Name.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).DeleteOpsZone">DATABASE:DeleteOpsZone(ZoneName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Deletes a <a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a> from the DATABASE based on the zone name.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1872,6 +1884,12 @@ Moose refers to <strong>_DATABASE</strong> within the framework extensively, but
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).FindOpsGroupFromUnit">DATABASE:FindOpsGroupFromUnit(unitname)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Find an OPSGROUP (FLIGHTGROUP, ARMYGROUP, NAVYGROUP) in the data base for a given unit.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).FindOpsZone">DATABASE:FindOpsZone(ZoneName)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Finds a <a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a> based on the zone name.</p>
</td>
</tr>
<tr class="w3-border">
@@ -1911,13 +1929,13 @@ Moose refers to <strong>_DATABASE</strong> within the framework extensively, but
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).ForEachCargo">DATABASE:ForEachCargo(IteratorFunction, ...)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).ForEachCargo">DATABASE:ForEachCargo(IteratorFunction, FinalizeFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the DATABASE and call an iterator function for each CARGO, providing the CARGO object to the function and optional parameters.</p>
</td>
</tr>
<tr class="w3-border">
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).ForEachClient">DATABASE:ForEachClient(IteratorFunction, ...)</a></p></td>
<td class="name w3-half w3-container" style="word-wrap: break-word"><p><a href="##(DATABASE).ForEachClient">DATABASE:ForEachClient(IteratorFunction, FinalizeFunction, ...)</a></p></td>
<td class="summary w3-half w3-container" style="word-wrap: break-word">
<p>Iterate the DATABASE and call an iterator function for each CLIENT, providing the CLIENT to the function and optional parameters.</p>
</td>
@@ -3138,6 +3156,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DATABASE).AddOpsZone" ><strong>DATABASE:AddOpsZone(OpsZone)</strong></a></h2>
</div>
<p>Adds a <a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a> based on the zone name in the DATABASE.</p>
<div id= "#Functions##AddOpsZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>DATABASE</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a>
<strong><strong>OpsZone</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The zone.</p>
</div>
</div>
</div>
</div>
</div>
@@ -3470,6 +3521,39 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DATABASE).DeleteOpsZone" ><strong>DATABASE:DeleteOpsZone(ZoneName)</strong></a></h2>
</div>
<p>Deletes a <a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a> from the DATABASE based on the zone name.</p>
<div id= "#Functions##DeleteOpsZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>DATABASE</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>ZoneName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the zone.</p>
</div>
</div>
</div>
</div>
</div>
@@ -3925,6 +4009,50 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
</div>
</div>
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DATABASE).FindOpsZone" ><strong>DATABASE:FindOpsZone(ZoneName)</strong></a></h2>
</div>
<p>Finds a <a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a> based on the zone name.</p>
<div id= "#Functions##FindOpsZone" class="w3-show w3-white">
<div class="w3-container w3-white" id="functiontype">
<h2><strong>Defined in:</strong></h2>
<div class="w3-margin-left">
<p>DATABASE</p>
</div>
<h2><strong>Parameter:</strong></h2>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
#string
<strong><strong>ZoneName</strong></strong>
</p>
</div>
<div class="w3-half">
<p>The name of the zone.</p>
</div>
</div>
<h2><strong>Return value:</strong></h2>
<div class="w3-row w3-border-bottom w3-margin-left">
<div class="w3-half">
<p><a href="Ops.OpsZone.html##(OPSZONE)">Ops.OpsZone#OPSZONE</a>:</p>
</div>
<div class="w3-half">
<p>The found OPSZONE.</p>
</div>
</div>
</div>
</div>
</div>
@@ -4221,7 +4349,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DATABASE).ForEachCargo" ><strong>DATABASE:ForEachCargo(IteratorFunction, ...)</strong></a></h2>
<h2><a id="#(DATABASE).ForEachCargo" ><strong>DATABASE:ForEachCargo(IteratorFunction, FinalizeFunction, ...)</strong></a></h2>
</div>
<p>Iterate the DATABASE and call an iterator function for each CARGO, providing the CARGO object to the function and optional parameters.</p>
@@ -4246,6 +4374,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>FinalizeFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
@@ -4275,7 +4413,7 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
<div class="w3-card-2 w3-padding-small w3-margin-top">
<div class="w3-theme-l2">
<h2><a id="#(DATABASE).ForEachClient" ><strong>DATABASE:ForEachClient(IteratorFunction, ...)</strong></a></h2>
<h2><a id="#(DATABASE).ForEachClient" ><strong>DATABASE:ForEachClient(IteratorFunction, FinalizeFunction, ...)</strong></a></h2>
</div>
<p>Iterate the DATABASE and call an iterator function for each CLIENT, providing the CLIENT to the function and optional parameters.</p>
@@ -4300,6 +4438,16 @@ When Moose is loaded statically, (as one file), tracing is switched off by defau
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>
<strong><strong>FinalizeFunction</strong></strong>
</p>
</div>
<div class="w3-half">
<p></p>
</div>
</div>
<div class="w3-row w3-margin-left w3-border-bottom w3-border-l2">
<div class="w3-half">
<p>