History

Further Menu API JSDoc improvements

David Rowe committed 9 years ago

Commit 4f083a11 parent bdb1bbe1 file · +2 −2Browse files

Showing the changes to interface/src/scripting/MenuScriptingInterface.h (1 of 1 file). Show all

Unified · Split

interface/src/scripting/MenuScriptingInterface.h+2−2
@@ -204,7 +204,7 @@ public slots: · 203 unmodified lines
204 * Check whether a menu or menu item is enabled. If disabled, the item is grayed out and unusable.204 * Check whether a menu or menu item is enabled. If disabled, the item is grayed out and unusable.
205 * Menus are enabled by default.205 * Menus are enabled by default.
206 * @function Menu.isMenuEnabled206 * @function Menu.isMenuEnabled
207 * @param {string} menuName The name of the menu to check.207 * @param {string} menuName The name of the menu or menu item to check.
208 * @returns {boolean} <code>true</code> if the menu is enabled, otherwise <code>false</code>.208 * @returns {boolean} <code>true</code> if the menu is enabled, otherwise <code>false</code>.
209 * @example <caption>Report with the Settings > Advanced Menus menu item is enabled.</caption>209 * @example <caption>Report with the Settings > Advanced Menus menu item is enabled.</caption>
210 * print(Menu.isMenuEnabled("Settings > Advanced Menus")); // true or false210 * print(Menu.isMenuEnabled("Settings > Advanced Menus")); // true or false
@@ -214,7 +214,7 @@ public slots: · 3 unmodified lines
214 /**jsdoc214 /**jsdoc
215 * Set a menu or menu item to be enabled or disabled. If disabled, the item is grayed out and unusable.215 * Set a menu or menu item to be enabled or disabled. If disabled, the item is grayed out and unusable.
216 * @function Menu.setMenuEnabled216 * @function Menu.setMenuEnabled
217 * @param {string} menuName - The name of the menu to modify.217 * @param {string} menuName - The name of the menu or menu item to modify.
218 * @param {boolean} isEnabled - If <code>true</code>, the menu will be enabled, otherwise it will be disabled.218 * @param {boolean} isEnabled - If <code>true</code>, the menu will be enabled, otherwise it will be disabled.
219 * @example <caption>Disable the Settings > Advanced Menus menu item.</caption>219 * @example <caption>Disable the Settings > Advanced Menus menu item.</caption>
220 * Menu.setMenuEnabled("Settings > Advanced Menus", false);220 * Menu.setMenuEnabled("Settings > Advanced Menus", false);

Keyboard shortcuts

General

Show keyboard shortcuts
?
Focus the current search
/

Issues and pull requests

Open filters
f

Issues, pull requests and Inbox

Select next item
j↓
Select previous item
k↑
Open selected item
Enter
Dismiss filters or clear selection
Esc

Repository code

Go to file
t