From 748052614fe2a1a44f2992ea7c70200c9592d3ef Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 21 Apr 2018 12:45:00 +1200 Subject: [PATCH] Doc review --- interface/src/Application.cpp | 4 ++-- .../scripting/ControllerScriptingInterface.h | 4 ++-- .../controllers/src/controllers/Actions.cpp | 18 +++++++++--------- .../src/controllers/ScriptingInterface.h | 8 ++++---- .../src/controllers/StandardController.cpp | 4 ++-- .../src/input-plugins/KeyboardMouseDevice.cpp | 6 +++--- plugins/oculus/src/OculusControllerManager.cpp | 2 +- plugins/openvr/src/ViveControllerManager.cpp | 2 +- 8 files changed, 24 insertions(+), 24 deletions(-) diff --git a/interface/src/Application.cpp b/interface/src/Application.cpp index 3177de5be4..492cf76241 100644 --- a/interface/src/Application.cpp +++ b/interface/src/Application.cpp @@ -690,8 +690,8 @@ private: /**jsdoc *

The Controller.Hardware.Application object has properties representing Interface's state. The property - * values are integer IDs, uniquely identifying each output. Read-only. These can be can be mapped to actions or - * functions or Controller.Standard items in a {@link RouteObject} mapping. Each data value is either + * values are integer IDs, uniquely identifying each output. Read-only. These can be mapped to actions or functions or + * Controller.Standard items in a {@link RouteObject} mapping. Each data value is either * 1.0 for "true" or 0.0 for "false".

* * diff --git a/interface/src/scripting/ControllerScriptingInterface.h b/interface/src/scripting/ControllerScriptingInterface.h index 4c1378f321..f19caa8478 100644 --- a/interface/src/scripting/ControllerScriptingInterface.h +++ b/interface/src/scripting/ControllerScriptingInterface.h @@ -299,10 +299,10 @@ public slots: virtual void setVPadHidden(bool hidden); // Call it when a window should hide it /**jsdoc - * Sets the amount of extra margins between the virtual game pad that is displayed on certain devices (e.g., Android) and + * Sets the amount of extra margin between the virtual game pad that is displayed on certain devices (e.g., Android) and * the bottom of the display. * @function Controller.setVPadExtraBottomMargin - * @param {number} margin - Integer number of pixels of extra margin. + * @param {number} margin - Integer number of pixels in the extra margin. */ virtual void setVPadExtraBottomMargin(int margin); diff --git a/libraries/controllers/src/controllers/Actions.cpp b/libraries/controllers/src/controllers/Actions.cpp index f13a906e3f..978b0888ba 100644 --- a/libraries/controllers/src/controllers/Actions.cpp +++ b/libraries/controllers/src/controllers/Actions.cpp @@ -191,23 +191,23 @@ namespace controller { * event. * - * - * - * + * - * - * - * + * - * * * * - * * @@ -221,7 +221,7 @@ namespace controller { * direction. * - * * diff --git a/libraries/controllers/src/controllers/ScriptingInterface.h b/libraries/controllers/src/controllers/ScriptingInterface.h index fa5a21a791..b468df0ff5 100644 --- a/libraries/controllers/src/controllers/ScriptingInterface.h +++ b/libraries/controllers/src/controllers/ScriptingInterface.h @@ -477,7 +477,7 @@ namespace controller { /**jsdoc * Enable processing of mouse "move", "press", "double-press", and "release" events into - * {@link Controller.Hardware-Keyboard|Controller.Hardware.Keyboard} outputs that was disabled using + * {@link Controller.Hardware-Keyboard|Controller.Hardware.Keyboard} outputs that were disabled using * {@link Controller.captureMouseEvents|captureMouseEvents}. * @function Controller.releaseMouseEvents */ @@ -497,7 +497,7 @@ namespace controller { * Enable processing of touch "begin", "update", and "end" events into * {@link Controller.Hardware|Controller.Hardware.Keyboard}, * {@link Controller.Hardware|Controller.Hardware.Touchscreen}, and - * {@link Controller.Hardware|Controller.Hardware.TouchscreenVirtualPad} outputs that was disabled using + * {@link Controller.Hardware|Controller.Hardware.TouchscreenVirtualPad} outputs that were disabled using * {@link Controller.captureTouchEvents|captureTouchEvents}. * @function Controller.releaseTouchEvents */ @@ -513,7 +513,7 @@ namespace controller { /**jsdoc * Enable processing of mouse wheel rotation events into {@link Controller.Hardware|Controller.Hardware.Keyboard} - * outputs that was disabled using {@link Controller.captureWheelEvents|captureWheelEvents}. + * outputs that wer disabled using {@link Controller.captureWheelEvents|captureWheelEvents}. * @function Controller.releaseWheelEvents */ virtual void releaseWheelEvents() { _wheelCaptured = false; } @@ -534,7 +534,7 @@ namespace controller { virtual void captureActionEvents() { _actionsCaptured = true; } /**jsdoc - * Enable translating and rotating the user's avatar in response to keyboard and controller controls that was disabled + * Enable translating and rotating the user's avatar in response to keyboard and controller controls that were disabled * using {@link Controller.captureActionEvents|captureActionEvents}. * @function Controller.releaseActionEvents */ diff --git a/libraries/controllers/src/controllers/StandardController.cpp b/libraries/controllers/src/controllers/StandardController.cpp index a7daeb6836..471943400d 100644 --- a/libraries/controllers/src/controllers/StandardController.cpp +++ b/libraries/controllers/src/controllers/StandardController.cpp @@ -30,7 +30,7 @@ void StandardController::focusOutEvent() { /**jsdoc *

The Controller.Standard object has properties representing standard controller outputs. Those for physical * controllers are based on the XBox controller, with aliases for PlayStation. The property values are integer IDs, uniquely - * identifying each output. Read-only. These can be can be mapped to actions or functions in a {@link RouteObject} + * identifying each output. Read-only. These can be mapped to actions or functions in a {@link RouteObject} * mapping.

* *

The data value provided by each control is either a number or a {@link Pose}. Numbers are typically normalized to @@ -64,7 +64,7 @@ void StandardController::focusOutEvent() { * *

* - * + * * * * diff --git a/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp b/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp index 74b007353d..8ecf527a14 100755 --- a/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp +++ b/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp @@ -218,9 +218,9 @@ controller::Input KeyboardMouseDevice::InputDevice::makeInput(KeyboardMouseDevic /**jsdoc *

The Controller.Hardware.Keyboard object has properties representing keyboard, mouse, and display touch - * events. The property values are integer IDs, uniquely identifying each output. Read-only. These can be can be - * mapped to actions or functions or Controller.Standard items in a {@link RouteObject} mapping. For presses, - * each data value is either 1.0 for "true" or 0.0 for "false".

+ * events. The property values are integer IDs, uniquely identifying each output. Read-only. These can be mapped to + * actions or functions or Controller.Standard items in a {@link RouteObject} mapping. For presses, each data + * value is either 1.0 for "true" or 0.0 for "false".

*
UiNavGroupnumbernumberGenerate a keyboard tab or back-tab key event. *
UiNavSelectnumbernumberGenerate keyboard an Enter key event. + *
UiNavSelectnumbernumberGenerate a keyboard Enter key event. *
UiNavBacknumbernumberGenerate keyboard an Esc key event.
LeftHandClicknumbernumberDeprecated: : No action. + *
UiNavBacknumbernumberGenerate a keyboard Esc key event.
LeftHandClicknumbernumberDeprecated: No action. *
RightHandClicknumbernumberDeprecated:: No action. + *
RightHandClicknumbernumberDeprecated: No action. *
ShiftnumbernumberDeprecated:: No action.
PrimaryActionnumbernumberDeprecated: : No action. + *
ShiftnumbernumberDeprecated: No action.
PrimaryActionnumbernumberDeprecated: No action. *
SecondaryActionnumbernumberDeprecated:: No action. + *
SecondaryActionnumbernumberDeprecated: No action. *
Aliases
BackwardnumbernumberAlias for TranslateZ in the * positive direction.
ForwardnumbernumberAlias for TranslateZ in the negative + *
ForwardnumbernumberAlias for TranslateZ in the negative * direction.
StrafeRightnumbernumberAlias for TranslateX in the * positive direction.
PitchUpnumbernumberAlias for Pitch in the negative * direction.
YawLeftnumbernumberAlias of Yaw in the positive + *
YawLeftnumbernumberAlias for Yaw in the positive * direction.
YawRightnumbernumberAlias for Yaw in the negative * direction.
Sticks
LXnumbernumberLeft stick x-axis scale.
LYnumbernumberleft stick y-axis scale.
LYnumbernumberLeft stick y-axis scale.
RXnumbernumberRight stick x-axis scale.
RYnumbernumberRight stick y-axis scale.
LSnumbernumberLeft stick button pressed.
* * diff --git a/plugins/oculus/src/OculusControllerManager.cpp b/plugins/oculus/src/OculusControllerManager.cpp index 29c2f9980e..b8761feed6 100644 --- a/plugins/oculus/src/OculusControllerManager.cpp +++ b/plugins/oculus/src/OculusControllerManager.cpp @@ -385,7 +385,7 @@ void OculusControllerManager::TouchDevice::stopHapticPulse(bool leftHand) { /**jsdoc *

The Controller.Hardware.OculusTouch object has properties representing Oculus Rift. The property values are - * integer IDs, uniquely identifying each output. Read-only. These can be can be mapped to actions or functions or + * integer IDs, uniquely identifying each output. Read-only. These can be mapped to actions or functions or * Controller.Standard items in a {@link RouteObject} mapping.

*
PropertyTypeDataDescription
* diff --git a/plugins/openvr/src/ViveControllerManager.cpp b/plugins/openvr/src/ViveControllerManager.cpp index bb0059eac9..cce0dadfb2 100644 --- a/plugins/openvr/src/ViveControllerManager.cpp +++ b/plugins/openvr/src/ViveControllerManager.cpp @@ -1234,7 +1234,7 @@ void ViveControllerManager::InputDevice::setConfigFromString(const QString& valu /**jsdoc *

The Controller.Hardware.Vive object has properties representing Vive. The property values are integer IDs, - * uniquely identifying each output. Read-only. These can be can be mapped to actions or functions or + * uniquely identifying each output. Read-only. These can be mapped to actions or functions or * Controller.Standard items in a {@link RouteObject} mapping.

*
*