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
1717
1818 class MenuItemProperties;
1919
20−/**jsdoc
20+/*@jsdoc
2121 * 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
2222 * the tablet when the "MENU" button is pressed.
2323 *
@@ -57,7 +57,7 @@ private slots: · 33 unmodified lines
5757 void menuItemTriggered();
5858
5959 public slots:
60− /**jsdoc
60+ /*@jsdoc
6161 * Adds a new top-level menu.
6262 * @function Menu.addMenu
6363 * @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
7373 */
7474 void addMenu(const QString& menuName, const QString& grouping = QString());
7575
76− /**jsdoc
76+ /*@jsdoc
7777 * Removes a top-level menu.
7878 * @function Menu.removeMenu
7979 * @param {string} menuName - Name of the menu to remove.
@@ -83,7 +83,7 @@ public slots: · 3 unmodified lines
8383 */
8484 void removeMenu(const QString& menuName);
8585
86− /**jsdoc
86+ /*@jsdoc
8787 * Checks whether a top-level menu exists.
8888 * @function Menu.menuExists
8989 * @param {string} menuName - Name of the menu to check exists.
@@ -95,7 +95,7 @@ public slots: · 5 unmodified lines
9595 */
9696 bool menuExists(const QString& menuName);
9797
98− /**jsdoc
98+ /*@jsdoc
9999 * Adds a separator with an unclickable label below it. The separator will be placed at the bottom of the menu. To add a
100100 * separator at a specific point in the menu, use {@link Menu.addMenuItem} with {@link Menu.MenuItemProperties} instead.
101101 * @function Menu.addSeparator
@@ -106,7 +106,7 @@ public slots: · 4 unmodified lines
106106 */
107107 void addSeparator(const QString& menuName, const QString& separatorName);
108108
109− /**jsdoc
109+ /*@jsdoc
110110 * Removes a separator from a menu.
111111 * @function Menu.removeSeparator
112112 * @param {string} menuName - Name of the menu to remove the separator from.
@@ -116,7 +116,7 @@ public slots: · 3 unmodified lines
116116 */
117117 void removeSeparator(const QString& menuName, const QString& separatorName);
118118
119− /**jsdoc
119+ /*@jsdoc
120120 * Adds a new menu item to a menu. The menu item is specified using {@link Menu.MenuItemProperties}.
121121 * @function Menu.addMenuItem
122122 * @param {Menu.MenuItemProperties} properties - Properties of the menu item to create.
@@ -130,7 +130,7 @@ public slots: · 7 unmodified lines
130130 */
131131 void addMenuItem(const MenuItemProperties& properties);
132132
133− /**jsdoc
133+ /*@jsdoc
134134 * Adds a new menu item to a menu. The new item is added at the end of the menu.
135135 * @function Menu.addMenuItem
136136 * @variation 0
@@ -143,7 +143,7 @@ public slots: · 6 unmodified lines
143143 void addMenuItem(const QString& menuName, const QString& menuitem, const QString& shortcutKey);
144144 void addMenuItem(const QString& menuName, const QString& menuitem);
145145
146− /**jsdoc
146+ /*@jsdoc
147147 * Removes a menu item from a menu.
148148 * @function Menu.removeMenuItem
149149 * @param {string} menuName - Name of the menu to remove a menu item from.
@@ -153,7 +153,7 @@ public slots: · 3 unmodified lines
153153 */
154154 void removeMenuItem(const QString& menuName, const QString& menuitem);
155155
156− /**jsdoc
156+ /*@jsdoc
157157 * Checks whether a menu item exists.
158158 * @function Menu.menuItemExists
159159 * @param {string} menuName - Name of the menu that the menu item is in.
@@ -166,7 +166,7 @@ public slots: · 6 unmodified lines
166166 */
167167 bool menuItemExists(const QString& menuName, const QString& menuitem);
168168
169− /**jsdoc
169+ /*@jsdoc
170170 * Checks whether a checkable menu item is checked.
171171 * @function Menu.isOptionChecked
172172 * @param {string} menuOption - The name of the menu item.
@@ -176,7 +176,7 @@ public slots: · 3 unmodified lines
176176 */
177177 bool isOptionChecked(const QString& menuOption);
178178
179− /**jsdoc
179+ /*@jsdoc
180180 * Sets a checkable menu item as checked or unchecked.
181181 * @function Menu.setIsOptionChecked
182182 * @param {string} menuOption - The name of the menu item to modify.
@@ -187,7 +187,7 @@ public slots: · 4 unmodified lines
187187 */
188188 void setIsOptionChecked(const QString& menuOption, bool isChecked);
189189
190− /**jsdoc
190+ /*@jsdoc
191191 * Triggers a menu item as if the user clicked on it.
192192 * @function Menu.triggerOption
193193 * @param {string} menuOption - The name of the menu item to trigger.
@@ -196,7 +196,7 @@ public slots: · 2 unmodified lines
196196 */
197197 void triggerOption(const QString& menuOption);
198198
199− /**jsdoc
199+ /*@jsdoc
200200 * Checks whether a menu or menu item is enabled. If disabled, the item is grayed out and unusable.
201201 * Menus are enabled by default.
202202 * @function Menu.isMenuEnabled
@@ -207,7 +207,7 @@ public slots: · 4 unmodified lines
207207 */
208208 bool isMenuEnabled(const QString& menuName);
209209
210− /**jsdoc
210+ /*@jsdoc
211211 * Sets a menu or menu item to be enabled or disabled. If disabled, the item is grayed out and unusable.
212212 * @function Menu.setMenuEnabled
213213 * @param {string} menuName - The name of the menu or menu item to modify.
@@ -219,7 +219,7 @@ public slots: · 5 unmodified lines
219219 void setMenuEnabled(const QString& menuName, bool isEnabled);
220220
221221 signals:
222− /**jsdoc
222+ /*@jsdoc
223223 * Triggered when a menu item is clicked or triggered by {@link Menu.triggerOption}.
224224 * @function Menu.menuItemEvent
225225 * @param {string} menuItem - Name of the menu item that was clicked or triggered.