History

Convert all "/**jsdoc" occurrences to "/*@jsdoc"

David Rowe committed 5 years ago

Commit 4d11d1d1 parent 2130dea220 files · +2319 −2319Browse files

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

Unified · Split

interface/src/scripting/MenuScriptingInterface.h+16−16
@@ -17,7 +17,7 @@ · 16 unmodified lines
17 17
18class MenuItemProperties;18class MenuItemProperties;
19 19
20/**jsdoc20/*@jsdoc
21 * The <code>Menu</code> API provides access to the menu that is displayed at the top of the window on a user's desktop and in 21 * The <code>Menu</code> API provides access to the menu that is displayed at the top of the window on a user's desktop and in
22 * the tablet when the "MENU" button is pressed.22 * the tablet when the "MENU" button is pressed.
23 *23 *
@@ -57,7 +57,7 @@ private slots: · 33 unmodified lines
57 void menuItemTriggered();57 void menuItemTriggered();
58 58
59public slots:59public slots:
60 /**jsdoc60 /*@jsdoc
61 * Adds a new top-level menu.61 * Adds a new top-level menu.
62 * @function Menu.addMenu62 * @function Menu.addMenu
63 * @param {string} menuName - Name that will be displayed for the menu. Nested menus can be specified using the 63 * @param {string} menuName - Name that will be displayed for the menu. Nested menus can be specified using the
@@ -73,7 +73,7 @@ public slots: · 9 unmodified lines
73 */73 */
74 void addMenu(const QString& menuName, const QString& grouping = QString());74 void addMenu(const QString& menuName, const QString& grouping = QString());
75 75
76 /**jsdoc76 /*@jsdoc
77 * Removes a top-level menu.77 * Removes a top-level menu.
78 * @function Menu.removeMenu78 * @function Menu.removeMenu
79 * @param {string} menuName - Name of the menu to remove.79 * @param {string} menuName - Name of the menu to remove.
@@ -83,7 +83,7 @@ public slots: · 3 unmodified lines
83 */83 */
84 void removeMenu(const QString& menuName);84 void removeMenu(const QString& menuName);
85 85
86 /**jsdoc86 /*@jsdoc
87 * Checks whether a top-level menu exists.87 * Checks whether a top-level menu exists.
88 * @function Menu.menuExists88 * @function Menu.menuExists
89 * @param {string} menuName - Name of the menu to check exists.89 * @param {string} menuName - Name of the menu to check exists.
@@ -95,7 +95,7 @@ public slots: · 5 unmodified lines
95 */95 */
96 bool menuExists(const QString& menuName);96 bool menuExists(const QString& menuName);
97 97
98 /**jsdoc98 /*@jsdoc
99 * Adds a separator with an unclickable label below it. The separator will be placed at the bottom of the menu. To add a 99 * Adds a separator with an unclickable label below it. The separator will be placed at the bottom of the menu. To add a
100 * separator at a specific point in the menu, use {@link Menu.addMenuItem} with {@link Menu.MenuItemProperties} instead.100 * separator at a specific point in the menu, use {@link Menu.addMenuItem} with {@link Menu.MenuItemProperties} instead.
101 * @function Menu.addSeparator101 * @function Menu.addSeparator
@@ -106,7 +106,7 @@ public slots: · 4 unmodified lines
106 */106 */
107 void addSeparator(const QString& menuName, const QString& separatorName);107 void addSeparator(const QString& menuName, const QString& separatorName);
108 108
109 /**jsdoc109 /*@jsdoc
110 * Removes a separator from a menu.110 * Removes a separator from a menu.
111 * @function Menu.removeSeparator111 * @function Menu.removeSeparator
112 * @param {string} menuName - Name of the menu to remove the separator from.112 * @param {string} menuName - Name of the menu to remove the separator from.
@@ -116,7 +116,7 @@ public slots: · 3 unmodified lines
116 */116 */
117 void removeSeparator(const QString& menuName, const QString& separatorName);117 void removeSeparator(const QString& menuName, const QString& separatorName);
118 118
119 /**jsdoc119 /*@jsdoc
120 * Adds a new menu item to a menu. The menu item is specified using {@link Menu.MenuItemProperties}.120 * Adds a new menu item to a menu. The menu item is specified using {@link Menu.MenuItemProperties}.
121 * @function Menu.addMenuItem121 * @function Menu.addMenuItem
122 * @param {Menu.MenuItemProperties} properties - Properties of the menu item to create.122 * @param {Menu.MenuItemProperties} properties - Properties of the menu item to create.
@@ -130,7 +130,7 @@ public slots: · 7 unmodified lines
130 */130 */
131 void addMenuItem(const MenuItemProperties& properties);131 void addMenuItem(const MenuItemProperties& properties);
132 132
133 /**jsdoc133 /*@jsdoc
134 * Adds a new menu item to a menu. The new item is added at the end of the menu.134 * Adds a new menu item to a menu. The new item is added at the end of the menu.
135 * @function Menu.addMenuItem135 * @function Menu.addMenuItem
136 * @variation 0136 * @variation 0
@@ -143,7 +143,7 @@ public slots: · 6 unmodified lines
143 void addMenuItem(const QString& menuName, const QString& menuitem, const QString& shortcutKey);143 void addMenuItem(const QString& menuName, const QString& menuitem, const QString& shortcutKey);
144 void addMenuItem(const QString& menuName, const QString& menuitem);144 void addMenuItem(const QString& menuName, const QString& menuitem);
145 145
146 /**jsdoc146 /*@jsdoc
147 * Removes a menu item from a menu.147 * Removes a menu item from a menu.
148 * @function Menu.removeMenuItem148 * @function Menu.removeMenuItem
149 * @param {string} menuName - Name of the menu to remove a menu item from.149 * @param {string} menuName - Name of the menu to remove a menu item from.
@@ -153,7 +153,7 @@ public slots: · 3 unmodified lines
153 */153 */
154 void removeMenuItem(const QString& menuName, const QString& menuitem);154 void removeMenuItem(const QString& menuName, const QString& menuitem);
155 155
156 /**jsdoc156 /*@jsdoc
157 * Checks whether a menu item exists.157 * Checks whether a menu item exists.
158 * @function Menu.menuItemExists158 * @function Menu.menuItemExists
159 * @param {string} menuName - Name of the menu that the menu item is in.159 * @param {string} menuName - Name of the menu that the menu item is in.
@@ -166,7 +166,7 @@ public slots: · 6 unmodified lines
166 */166 */
167 bool menuItemExists(const QString& menuName, const QString& menuitem);167 bool menuItemExists(const QString& menuName, const QString& menuitem);
168 168
169 /**jsdoc169 /*@jsdoc
170 * Checks whether a checkable menu item is checked.170 * Checks whether a checkable menu item is checked.
171 * @function Menu.isOptionChecked171 * @function Menu.isOptionChecked
172 * @param {string} menuOption - The name of the menu item.172 * @param {string} menuOption - The name of the menu item.
@@ -176,7 +176,7 @@ public slots: · 3 unmodified lines
176 */176 */
177 bool isOptionChecked(const QString& menuOption);177 bool isOptionChecked(const QString& menuOption);
178 178
179 /**jsdoc179 /*@jsdoc
180 * Sets a checkable menu item as checked or unchecked.180 * Sets a checkable menu item as checked or unchecked.
181 * @function Menu.setIsOptionChecked181 * @function Menu.setIsOptionChecked
182 * @param {string} menuOption - The name of the menu item to modify.182 * @param {string} menuOption - The name of the menu item to modify.
@@ -187,7 +187,7 @@ public slots: · 4 unmodified lines
187 */187 */
188 void setIsOptionChecked(const QString& menuOption, bool isChecked);188 void setIsOptionChecked(const QString& menuOption, bool isChecked);
189 189
190 /**jsdoc190 /*@jsdoc
191 * Triggers a menu item as if the user clicked on it.191 * Triggers a menu item as if the user clicked on it.
192 * @function Menu.triggerOption192 * @function Menu.triggerOption
193 * @param {string} menuOption - The name of the menu item to trigger.193 * @param {string} menuOption - The name of the menu item to trigger.
@@ -196,7 +196,7 @@ public slots: · 2 unmodified lines
196 */196 */
197 void triggerOption(const QString& menuOption);197 void triggerOption(const QString& menuOption);
198 198
199 /**jsdoc199 /*@jsdoc
200 * Checks whether a menu or menu item is enabled. If disabled, the item is grayed out and unusable.200 * Checks whether a menu or menu item is enabled. If disabled, the item is grayed out and unusable.
201 * Menus are enabled by default.201 * Menus are enabled by default.
202 * @function Menu.isMenuEnabled202 * @function Menu.isMenuEnabled
@@ -207,7 +207,7 @@ public slots: · 4 unmodified lines
207 */207 */
208 bool isMenuEnabled(const QString& menuName);208 bool isMenuEnabled(const QString& menuName);
209 209
210 /**jsdoc210 /*@jsdoc
211 * Sets a menu or menu item to be enabled or disabled. If disabled, the item is grayed out and unusable.211 * Sets a menu or menu item to be enabled or disabled. If disabled, the item is grayed out and unusable.
212 * @function Menu.setMenuEnabled212 * @function Menu.setMenuEnabled
213 * @param {string} menuName - The name of the menu or menu item to modify.213 * @param {string} menuName - The name of the menu or menu item to modify.
@@ -219,7 +219,7 @@ public slots: · 5 unmodified lines
219 void setMenuEnabled(const QString& menuName, bool isEnabled);219 void setMenuEnabled(const QString& menuName, bool isEnabled);
220 220
221signals:221signals:
222 /**jsdoc222 /*@jsdoc
223 * Triggered when a menu item is clicked or triggered by {@link Menu.triggerOption}.223 * Triggered when a menu item is clicked or triggered by {@link Menu.triggerOption}.
224 * @function Menu.menuItemEvent224 * @function Menu.menuItemEvent
225 * @param {string} menuItem - Name of the menu item that was clicked or triggered.225 * @param {string} menuItem - Name of the menu item that was clicked or triggered.