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/ControllerScriptingInterface.h (1 of 220 files). Show all

Unified · Split

interface/src/scripting/ControllerScriptingInterface.h+22−22
@@ -25,7 +25,7 @@ · 24 unmodified lines
2525 class ScriptEngine;
2626
2727
28−/**jsdoc
28+/*@jsdoc
2929 * The <code>Controller</code> API provides facilities to interact with computer and controller hardware.
3030 *
3131 * <h3>Facilities</h3>
@@ -265,7 +265,7 @@ public: · 233 unmodified lines
265265
266266 public slots:
267267
268− /**jsdoc
268+ /*@jsdoc
269269 * Disables default Interface actions for a particular key event.
270270 * @function Controller.captureKeyEvents
271271 * @param {KeyEvent} event - Details of the key event to be captured. The <code>key</code> property must be specified. The
@@ -284,7 +284,7 @@ public slots: · 12 unmodified lines
284284 */
285285 virtual void captureKeyEvents(const KeyEvent& event);
286286
287− /**jsdoc
287+ /*@jsdoc
288288 * Re-enables default Interface actions for a particular key event that has been disabled using
289289 * {@link Controller.captureKeyEvents|captureKeyEvents}.
290290 * @function Controller.releaseKeyEvents
@@ -293,7 +293,7 @@ public slots: · 2 unmodified lines
293293 */
294294 virtual void releaseKeyEvents(const KeyEvent& event);
295295
296− /**jsdoc
296+ /*@jsdoc
297297 * Disables default Interface actions for a joystick.
298298 * @function Controller.captureJoystick
299299 * @param {number} joystickID - The integer ID of the joystick.
@@ -301,7 +301,7 @@ public slots: · 1 unmodified line
301301 */
302302 virtual void captureJoystick(int joystickIndex);
303303
304− /**jsdoc
304+ /*@jsdoc
305305 * Re-enables default Interface actions for a joystick that has been disabled using
306306 * {@link Controller.captureJoystick|captureJoystick}.
307307 * @function Controller.releaseJoystick
@@ -310,7 +310,7 @@ public slots: · 2 unmodified lines
310310 */
311311 virtual void releaseJoystick(int joystickIndex);
312312
313− /**jsdoc
313+ /*@jsdoc
314314 * Disables {@link Entities.mousePressOnEntity} and {@link Entities.mouseDoublePressOnEntity} events on entities.
315315 * @function Controller.captureEntityClickEvents
316316 * @example <caption>Disable entity click events for a short period.</caption>
@@ -328,7 +328,7 @@ public slots: · 11 unmodified lines
328328 */
329329 virtual void captureEntityClickEvents();
330330
331− /**jsdoc
331+ /*@jsdoc
332332 * Re-enables {@link Entities.mousePressOnEntity} and {@link Entities.mouseDoublePressOnEntity} events on entities that were
333333 * disabled using {@link Controller.captureEntityClickEvents|captureEntityClickEvents}.
334334 * @function Controller.releaseEntityClickEvents
@@ -336,14 +336,14 @@ public slots: · 1 unmodified line
336336 virtual void releaseEntityClickEvents();
337337
338338
339− /**jsdoc
339+ /*@jsdoc
340340 * Gets the dimensions of the Interface window's interior if in desktop mode or the HUD surface if in HMD mode.
341341 * @function Controller.getViewportDimensions
342342 * @returns {Vec2} The dimensions of the Interface window interior if in desktop mode or HUD surface if in HMD mode.
343343 */
344344 virtual glm::vec2 getViewportDimensions() const;
345345
346− /**jsdoc
346+ /*@jsdoc
347347 * Gets the recommended area to position UI on the HUD surface if in HMD mode or Interface's window interior if in desktop
348348 * mode.
349349 * @function Controller.getRecommendedHUDRect
@@ -351,7 +351,7 @@ public slots: · 1 unmodified line
351351 */
352352 virtual QVariant getRecommendedHUDRect() const;
353353
354− /**jsdoc
354+ /*@jsdoc
355355 * Enables or disables the virtual game pad that is displayed on certain devices (e.g., Android).
356356 * @function Controller.setVPadEnabled
357357 * @param {boolean} enable - If <code>true</code> then the virtual game pad doesn't work, otherwise it does work provided
@@ -360,14 +360,14 @@ public slots: · 2 unmodified lines
360360 */
361361 virtual void setVPadEnabled(bool enable);
362362
363− /**jsdoc
363+ /*@jsdoc
364364 * Shows or hides the virtual game pad that is displayed on certain devices (e.g., Android).
365365 * @function Controller.setVPadHidden
366366 * @param {boolean} hidden - If <code>true</code> then the virtual game pad is hidden, otherwise it is shown.
367367 */
368368 virtual void setVPadHidden(bool hidden); // Call it when a window should hide it
369369
370− /**jsdoc
370+ /*@jsdoc
371371 * Sets the amount of extra margin between the virtual game pad that is displayed on certain devices (e.g., Android) and
372372 * the bottom of the display.
373373 * @function Controller.setVPadExtraBottomMargin
@@ -376,7 +376,7 @@ public slots: · 2 unmodified lines
376376 virtual void setVPadExtraBottomMargin(int margin);
377377
378378 signals:
379− /**jsdoc
379+ /*@jsdoc
380380 * Triggered when a keyboard key is pressed.
381381 * @function Controller.keyPressEvent
382382 * @param {KeyEvent} event - Details of the key press.
@@ -388,7 +388,7 @@ signals: · 5 unmodified lines
388388 */
389389 void keyPressEvent(const KeyEvent& event);
390390
391− /**jsdoc
391+ /*@jsdoc
392392 * Triggered when a keyboard key is released from being pressed.
393393 * @function Controller.keyReleaseEvent
394394 * @param {KeyEvent} event - Details of the key release.
@@ -396,7 +396,7 @@ signals: · 1 unmodified line
396396 */
397397 void keyReleaseEvent(const KeyEvent& event);
398398
399− /**jsdoc
399+ /*@jsdoc
400400 * Triggered when the mouse moves.
401401 * @function Controller.mouseMoveEvent
402402 * @param {MouseEvent} event - Details of the mouse movement.
@@ -408,7 +408,7 @@ signals: · 5 unmodified lines
408408 */
409409 void mouseMoveEvent(const MouseEvent& event);
410410
411− /**jsdoc
411+ /*@jsdoc
412412 * Triggered when a mouse button is pressed.
413413 * @function Controller.mousePressEvent
414414 * @param {MouseEvent} event - Details of the button press.
@@ -416,7 +416,7 @@ signals: · 1 unmodified line
416416 */
417417 void mousePressEvent(const MouseEvent& event);
418418
419− /**jsdoc
419+ /*@jsdoc
420420 * Triggered when a mouse button is double-pressed.
421421 * @function Controller.mouseDoublePressEvent
422422 * @param {MouseEvent} event - Details of the button double-press.
@@ -424,7 +424,7 @@ signals: · 1 unmodified line
424424 */
425425 void mouseDoublePressEvent(const MouseEvent& event);
426426
427− /**jsdoc
427+ /*@jsdoc
428428 * Triggered when a mouse button is released from being pressed.
429429 * @function Controller.mouseReleaseEvent
430430 * @param {MouseEvent} event - Details of the button release.
@@ -432,7 +432,7 @@ signals: · 1 unmodified line
432432 */
433433 void mouseReleaseEvent(const MouseEvent& event);
434434
435− /**jsdoc
435+ /*@jsdoc
436436 * Triggered when a touch event starts in the Interface window on a touch-enabled display or device.
437437 * @function Controller.touchBeginEvent
438438 * @param {TouchEvent} event - Details of the touch begin.
@@ -444,7 +444,7 @@ signals: · 5 unmodified lines
444444 */
445445 void touchBeginEvent(const TouchEvent& event);
446446
447− /**jsdoc
447+ /*@jsdoc
448448 * Triggered when a touch event ends in the Interface window on a touch-enabled display or device.
449449 * @function Controller.touchEndEvent
450450 * @param {TouchEvent} event - Details of the touch end.
@@ -452,7 +452,7 @@ signals: · 1 unmodified line
452452 */
453453 void touchEndEvent(const TouchEvent& event);
454454
455− /**jsdoc
455+ /*@jsdoc
456456 * Triggered when a touch event update occurs in the Interface window on a touch-enabled display or device.
457457 * @function Controller.touchUpdateEvent
458458 * @param {TouchEvent} event - Details of the touch update.
@@ -460,7 +460,7 @@ signals: · 1 unmodified line
460460 */
461461 void touchUpdateEvent(const TouchEvent& event);
462462
463− /**jsdoc
463+ /*@jsdoc
464464 * Triggered when the mouse wheel is rotated.
465465 * @function Controller.wheelEvent
466466 * @param {WheelEvent} event - Details of the wheel movement.