mirror of
https://github.com/FlightControl-Master/MOOSE.git
synced 2025-10-29 16:58:06 +00:00
Documentation improvements.
This commit is contained in:
FlightControl_Master
@@ -241,6 +241,12 @@ classes are derived from, in order to set commands.</p>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).MenuRemoveParent">MENU_BASE.MenuRemoveParent</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).MenuTag">MENU_BASE.MenuTag</a></td>
|
||||
<td class="summary">
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -259,6 +265,12 @@ classes are derived from, in order to set commands.</p>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).SetRemoveParent">MENU_BASE:SetRemoveParent(RemoveParent)</a></td>
|
||||
<td class="summary">
|
||||
<p>Sets a <a href="Menu.html">Menu</a> to remove automatically the parent menu when the menu removed is the last child menu of that parent <a href="Menu.html">Menu</a>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_BASE).SetTag">MENU_BASE:SetTag(MenuTag)</a></td>
|
||||
<td class="summary">
|
||||
<p>Sets a tag for later selection of menu refresh.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -406,13 +418,13 @@ classes are derived from, in order to set commands.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).Remove">MENU_GROUP:Remove(MenuTime)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).Remove">MENU_GROUP:Remove(MenuTime, MenuTag)</a></td>
|
||||
<td class="summary">
|
||||
<p>Removes the main menu and sub menus recursively of this MENU_GROUP.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).RemoveSubMenus">MENU_GROUP:RemoveSubMenus(MenuTime)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP).RemoveSubMenus">MENU_GROUP:RemoveSubMenus(MenuTime, MenuTag, Menutag)</a></td>
|
||||
<td class="summary">
|
||||
<p>Removes the sub menus recursively of this MENU_GROUP.</p>
|
||||
</td>
|
||||
@@ -464,7 +476,7 @@ classes are derived from, in order to set commands.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP_COMMAND).Remove">MENU_GROUP_COMMAND:Remove(MenuTime)</a></td>
|
||||
<td class="name" nowrap="nowrap"><a href="##(MENU_GROUP_COMMAND).Remove">MENU_GROUP_COMMAND:Remove(MenuTime, MenuTag)</a></td>
|
||||
<td class="summary">
|
||||
<p>Removes a menu structure for a group.</p>
|
||||
</td>
|
||||
@@ -896,6 +908,20 @@ The text of the child menu.</p>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<em></em>
|
||||
<a id="#(MENU_BASE).MenuTag" >
|
||||
<strong>MENU_BASE.MenuTag</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -979,6 +1005,33 @@ If true, the parent menu is automatically removed when this menu is the last chi
|
||||
<p><em><a href="##(MENU_BASE)">#MENU_BASE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
<dt>
|
||||
|
||||
<a id="#(MENU_BASE).SetTag" >
|
||||
<strong>MENU_BASE:SetTag(MenuTag)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Sets a tag for later selection of menu refresh.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em>#string MenuTag </em></code>:
|
||||
A Tag or Key that will filter only menu items set with this key.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
<p><em><a href="##(MENU_BASE)">#MENU_BASE</a>:</em></p>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="function">
|
||||
@@ -1534,19 +1587,25 @@ self</p>
|
||||
<dt>
|
||||
|
||||
<a id="#(MENU_GROUP).Remove" >
|
||||
<strong>MENU_GROUP:Remove(MenuTime)</strong>
|
||||
<strong>MENU_GROUP:Remove(MenuTime, MenuTag)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Removes the main menu and sub menus recursively of this MENU_GROUP.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> MenuTime </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> MenuTag </em></code>:
|
||||
A Tag or Key to filter the menus to be refreshed with the Tag set.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
@@ -1560,19 +1619,30 @@ self</p>
|
||||
<dt>
|
||||
|
||||
<a id="#(MENU_GROUP).RemoveSubMenus" >
|
||||
<strong>MENU_GROUP:RemoveSubMenus(MenuTime)</strong>
|
||||
<strong>MENU_GROUP:RemoveSubMenus(MenuTime, MenuTag, Menutag)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Removes the sub menus recursively of this MENU_GROUP.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> MenuTime </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> MenuTag </em></code>:
|
||||
A Tag or Key to filter the menus to be refreshed with the Tag set.</p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> Menutag </em></code>: </p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
@@ -1729,19 +1799,25 @@ An argument for the function.</p>
|
||||
<dt>
|
||||
|
||||
<a id="#(MENU_GROUP_COMMAND).Remove" >
|
||||
<strong>MENU_GROUP_COMMAND:Remove(MenuTime)</strong>
|
||||
<strong>MENU_GROUP_COMMAND:Remove(MenuTime, MenuTag)</strong>
|
||||
</a>
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<p>Removes a menu structure for a group.</p>
|
||||
|
||||
<h3>Parameter</h3>
|
||||
<h3>Parameters</h3>
|
||||
<ul>
|
||||
<li>
|
||||
|
||||
<p><code><em> MenuTime </em></code>: </p>
|
||||
|
||||
</li>
|
||||
<li>
|
||||
|
||||
<p><code><em> MenuTag </em></code>:
|
||||
A Tag or Key to filter the menus to be refreshed with the Tag set.</p>
|
||||
|
||||
</li>
|
||||
</ul>
|
||||
<h3>Return value</h3>
|
||||
|
||||
Reference in New Issue
Block a user