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
25class ScriptEngine;25class ScriptEngine;
26 26
27 27
28/**jsdoc28/*@jsdoc
29 * The <code>Controller</code> API provides facilities to interact with computer and controller hardware.29 * The <code>Controller</code> API provides facilities to interact with computer and controller hardware.
30 *30 *
31 * <h3>Facilities</h3>31 * <h3>Facilities</h3>
@@ -265,7 +265,7 @@ public: · 233 unmodified lines
265 265
266public slots:266public slots:
267 267
268 /**jsdoc268 /*@jsdoc
269 * Disables default Interface actions for a particular key event.269 * Disables default Interface actions for a particular key event.
270 * @function Controller.captureKeyEvents270 * @function Controller.captureKeyEvents
271 * @param {KeyEvent} event - Details of the key event to be captured. The <code>key</code> property must be specified. The 271 * @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
284 */284 */
285 virtual void captureKeyEvents(const KeyEvent& event);285 virtual void captureKeyEvents(const KeyEvent& event);
286 286
287 /**jsdoc287 /*@jsdoc
288 * Re-enables default Interface actions for a particular key event that has been disabled using 288 * Re-enables default Interface actions for a particular key event that has been disabled using
289 * {@link Controller.captureKeyEvents|captureKeyEvents}.289 * {@link Controller.captureKeyEvents|captureKeyEvents}.
290 * @function Controller.releaseKeyEvents290 * @function Controller.releaseKeyEvents
@@ -293,7 +293,7 @@ public slots: · 2 unmodified lines
293 */293 */
294 virtual void releaseKeyEvents(const KeyEvent& event);294 virtual void releaseKeyEvents(const KeyEvent& event);
295 295
296 /**jsdoc296 /*@jsdoc
297 * Disables default Interface actions for a joystick.297 * Disables default Interface actions for a joystick.
298 * @function Controller.captureJoystick298 * @function Controller.captureJoystick
299 * @param {number} joystickID - The integer ID of the joystick.299 * @param {number} joystickID - The integer ID of the joystick.
@@ -301,7 +301,7 @@ public slots: · 1 unmodified line
301 */301 */
302 virtual void captureJoystick(int joystickIndex);302 virtual void captureJoystick(int joystickIndex);
303 303
304 /**jsdoc304 /*@jsdoc
305 * Re-enables default Interface actions for a joystick that has been disabled using 305 * Re-enables default Interface actions for a joystick that has been disabled using
306 * {@link Controller.captureJoystick|captureJoystick}.306 * {@link Controller.captureJoystick|captureJoystick}.
307 * @function Controller.releaseJoystick307 * @function Controller.releaseJoystick
@@ -310,7 +310,7 @@ public slots: · 2 unmodified lines
310 */310 */
311 virtual void releaseJoystick(int joystickIndex);311 virtual void releaseJoystick(int joystickIndex);
312 312
313 /**jsdoc313 /*@jsdoc
314 * Disables {@link Entities.mousePressOnEntity} and {@link Entities.mouseDoublePressOnEntity} events on entities.314 * Disables {@link Entities.mousePressOnEntity} and {@link Entities.mouseDoublePressOnEntity} events on entities.
315 * @function Controller.captureEntityClickEvents315 * @function Controller.captureEntityClickEvents
316 * @example <caption>Disable entity click events for a short period.</caption>316 * @example <caption>Disable entity click events for a short period.</caption>
@@ -328,7 +328,7 @@ public slots: · 11 unmodified lines
328 */328 */
329 virtual void captureEntityClickEvents();329 virtual void captureEntityClickEvents();
330 330
331 /**jsdoc331 /*@jsdoc
332 * Re-enables {@link Entities.mousePressOnEntity} and {@link Entities.mouseDoublePressOnEntity} events on entities that were 332 * Re-enables {@link Entities.mousePressOnEntity} and {@link Entities.mouseDoublePressOnEntity} events on entities that were
333 * disabled using {@link Controller.captureEntityClickEvents|captureEntityClickEvents}.333 * disabled using {@link Controller.captureEntityClickEvents|captureEntityClickEvents}.
334 * @function Controller.releaseEntityClickEvents334 * @function Controller.releaseEntityClickEvents
@@ -336,14 +336,14 @@ public slots: · 1 unmodified line
336 virtual void releaseEntityClickEvents();336 virtual void releaseEntityClickEvents();
337 337
338 338
339 /**jsdoc339 /*@jsdoc
340 * Gets the dimensions of the Interface window's interior if in desktop mode or the HUD surface if in HMD mode.340 * Gets the dimensions of the Interface window's interior if in desktop mode or the HUD surface if in HMD mode.
341 * @function Controller.getViewportDimensions341 * @function Controller.getViewportDimensions
342 * @returns {Vec2} The dimensions of the Interface window interior if in desktop mode or HUD surface if in HMD mode.342 * @returns {Vec2} The dimensions of the Interface window interior if in desktop mode or HUD surface if in HMD mode.
343 */343 */
344 virtual glm::vec2 getViewportDimensions() const;344 virtual glm::vec2 getViewportDimensions() const;
345 345
346 /**jsdoc346 /*@jsdoc
347 * Gets the recommended area to position UI on the HUD surface if in HMD mode or Interface's window interior if in desktop 347 * Gets the recommended area to position UI on the HUD surface if in HMD mode or Interface's window interior if in desktop
348 * mode.348 * mode.
349 * @function Controller.getRecommendedHUDRect349 * @function Controller.getRecommendedHUDRect
@@ -351,7 +351,7 @@ public slots: · 1 unmodified line
351 */351 */
352 virtual QVariant getRecommendedHUDRect() const;352 virtual QVariant getRecommendedHUDRect() const;
353 353
354 /**jsdoc354 /*@jsdoc
355 * Enables or disables the virtual game pad that is displayed on certain devices (e.g., Android).355 * Enables or disables the virtual game pad that is displayed on certain devices (e.g., Android).
356 * @function Controller.setVPadEnabled356 * @function Controller.setVPadEnabled
357 * @param {boolean} enable - If <code>true</code> then the virtual game pad doesn't work, otherwise it does work provided 357 * @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
360 */360 */
361 virtual void setVPadEnabled(bool enable);361 virtual void setVPadEnabled(bool enable);
362 362
363 /**jsdoc363 /*@jsdoc
364 * Shows or hides the virtual game pad that is displayed on certain devices (e.g., Android).364 * Shows or hides the virtual game pad that is displayed on certain devices (e.g., Android).
365 * @function Controller.setVPadHidden365 * @function Controller.setVPadHidden
366 * @param {boolean} hidden - If <code>true</code> then the virtual game pad is hidden, otherwise it is shown.366 * @param {boolean} hidden - If <code>true</code> then the virtual game pad is hidden, otherwise it is shown.
367 */367 */
368 virtual void setVPadHidden(bool hidden); // Call it when a window should hide it368 virtual void setVPadHidden(bool hidden); // Call it when a window should hide it
369 369
370 /**jsdoc370 /*@jsdoc
371 * Sets the amount of extra margin between the virtual game pad that is displayed on certain devices (e.g., Android) and 371 * Sets the amount of extra margin between the virtual game pad that is displayed on certain devices (e.g., Android) and
372 * the bottom of the display.372 * the bottom of the display.
373 * @function Controller.setVPadExtraBottomMargin373 * @function Controller.setVPadExtraBottomMargin
@@ -376,7 +376,7 @@ public slots: · 2 unmodified lines
376 virtual void setVPadExtraBottomMargin(int margin);376 virtual void setVPadExtraBottomMargin(int margin);
377 377
378signals:378signals:
379 /**jsdoc379 /*@jsdoc
380 * Triggered when a keyboard key is pressed.380 * Triggered when a keyboard key is pressed.
381 * @function Controller.keyPressEvent381 * @function Controller.keyPressEvent
382 * @param {KeyEvent} event - Details of the key press.382 * @param {KeyEvent} event - Details of the key press.
@@ -388,7 +388,7 @@ signals: · 5 unmodified lines
388 */388 */
389 void keyPressEvent(const KeyEvent& event);389 void keyPressEvent(const KeyEvent& event);
390 390
391 /**jsdoc391 /*@jsdoc
392 * Triggered when a keyboard key is released from being pressed.392 * Triggered when a keyboard key is released from being pressed.
393 * @function Controller.keyReleaseEvent393 * @function Controller.keyReleaseEvent
394 * @param {KeyEvent} event - Details of the key release.394 * @param {KeyEvent} event - Details of the key release.
@@ -396,7 +396,7 @@ signals: · 1 unmodified line
396 */396 */
397 void keyReleaseEvent(const KeyEvent& event);397 void keyReleaseEvent(const KeyEvent& event);
398 398
399 /**jsdoc399 /*@jsdoc
400 * Triggered when the mouse moves.400 * Triggered when the mouse moves.
401 * @function Controller.mouseMoveEvent401 * @function Controller.mouseMoveEvent
402 * @param {MouseEvent} event - Details of the mouse movement.402 * @param {MouseEvent} event - Details of the mouse movement.
@@ -408,7 +408,7 @@ signals: · 5 unmodified lines
408 */408 */
409 void mouseMoveEvent(const MouseEvent& event);409 void mouseMoveEvent(const MouseEvent& event);
410 410
411 /**jsdoc411 /*@jsdoc
412 * Triggered when a mouse button is pressed.412 * Triggered when a mouse button is pressed.
413 * @function Controller.mousePressEvent413 * @function Controller.mousePressEvent
414 * @param {MouseEvent} event - Details of the button press.414 * @param {MouseEvent} event - Details of the button press.
@@ -416,7 +416,7 @@ signals: · 1 unmodified line
416 */416 */
417 void mousePressEvent(const MouseEvent& event);417 void mousePressEvent(const MouseEvent& event);
418 418
419 /**jsdoc419 /*@jsdoc
420 * Triggered when a mouse button is double-pressed.420 * Triggered when a mouse button is double-pressed.
421 * @function Controller.mouseDoublePressEvent421 * @function Controller.mouseDoublePressEvent
422 * @param {MouseEvent} event - Details of the button double-press.422 * @param {MouseEvent} event - Details of the button double-press.
@@ -424,7 +424,7 @@ signals: · 1 unmodified line
424 */424 */
425 void mouseDoublePressEvent(const MouseEvent& event);425 void mouseDoublePressEvent(const MouseEvent& event);
426 426
427 /**jsdoc427 /*@jsdoc
428 * Triggered when a mouse button is released from being pressed.428 * Triggered when a mouse button is released from being pressed.
429 * @function Controller.mouseReleaseEvent429 * @function Controller.mouseReleaseEvent
430 * @param {MouseEvent} event - Details of the button release.430 * @param {MouseEvent} event - Details of the button release.
@@ -432,7 +432,7 @@ signals: · 1 unmodified line
432 */432 */
433 void mouseReleaseEvent(const MouseEvent& event);433 void mouseReleaseEvent(const MouseEvent& event);
434 434
435 /**jsdoc435 /*@jsdoc
436 * Triggered when a touch event starts in the Interface window on a touch-enabled display or device.436 * Triggered when a touch event starts in the Interface window on a touch-enabled display or device.
437 * @function Controller.touchBeginEvent437 * @function Controller.touchBeginEvent
438 * @param {TouchEvent} event - Details of the touch begin.438 * @param {TouchEvent} event - Details of the touch begin.
@@ -444,7 +444,7 @@ signals: · 5 unmodified lines
444 */444 */
445 void touchBeginEvent(const TouchEvent& event);445 void touchBeginEvent(const TouchEvent& event);
446 446
447 /**jsdoc447 /*@jsdoc
448 * Triggered when a touch event ends in the Interface window on a touch-enabled display or device.448 * Triggered when a touch event ends in the Interface window on a touch-enabled display or device.
449 * @function Controller.touchEndEvent449 * @function Controller.touchEndEvent
450 * @param {TouchEvent} event - Details of the touch end.450 * @param {TouchEvent} event - Details of the touch end.
@@ -452,7 +452,7 @@ signals: · 1 unmodified line
452 */452 */
453 void touchEndEvent(const TouchEvent& event);453 void touchEndEvent(const TouchEvent& event);
454 454
455 /**jsdoc455 /*@jsdoc
456 * Triggered when a touch event update occurs in the Interface window on a touch-enabled display or device.456 * Triggered when a touch event update occurs in the Interface window on a touch-enabled display or device.
457 * @function Controller.touchUpdateEvent457 * @function Controller.touchUpdateEvent
458 * @param {TouchEvent} event - Details of the touch update.458 * @param {TouchEvent} event - Details of the touch update.
@@ -460,7 +460,7 @@ signals: · 1 unmodified line
460 */460 */
461 void touchUpdateEvent(const TouchEvent& event);461 void touchUpdateEvent(const TouchEvent& event);
462 462
463 /**jsdoc463 /*@jsdoc
464 * Triggered when the mouse wheel is rotated.464 * Triggered when the mouse wheel is rotated.
465 * @function Controller.wheelEvent465 * @function Controller.wheelEvent
466 * @param {WheelEvent} event - Details of the wheel movement.466 * @param {WheelEvent} event - Details of the wheel movement.