From e94cafd88ef44a50f226356a356e4318f45092f9 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Thu, 2 May 2019 20:16:53 +1200 Subject: [PATCH] Doc review --- libraries/controllers/src/controllers/Actions.cpp | 2 +- .../controllers/src/controllers/ScriptingInterface.h | 8 ++++---- .../controllers/src/controllers/StandardController.cpp | 4 ++-- .../src/controllers/impl/MappingBuilderProxy.h | 10 +++++----- .../src/input-plugins/KeyboardMouseDevice.cpp | 2 +- 5 files changed, 13 insertions(+), 13 deletions(-) diff --git a/libraries/controllers/src/controllers/Actions.cpp b/libraries/controllers/src/controllers/Actions.cpp index ffb5bd85ad..9f9d92fed7 100644 --- a/libraries/controllers/src/controllers/Actions.cpp +++ b/libraries/controllers/src/controllers/Actions.cpp @@ -178,7 +178,7 @@ namespace controller { * person view. * CycleCameranumbernumberCycle the camera view from first person, to * third person, to full screen mirror, then back to first person and repeat. - * ContextMenunumbernumberShow / hide the tablet. + * ContextMenunumbernumberShow/hide the tablet. * ToggleMutenumbernumberToggle the microphone mute. * TogglePushToTalknumbernumberToggle push to talk. * ToggleOverlaynumbernumberToggle the display of overlays. diff --git a/libraries/controllers/src/controllers/ScriptingInterface.h b/libraries/controllers/src/controllers/ScriptingInterface.h index 688b59e18c..84396fc8be 100644 --- a/libraries/controllers/src/controllers/ScriptingInterface.h +++ b/libraries/controllers/src/controllers/ScriptingInterface.h @@ -210,7 +210,7 @@ namespace controller { /**jsdoc * Triggers a haptic pulse on connected and enabled devices that have the capability. * @function Controller.triggerHapticPulse - * @param {number} strength - The strength of the haptic pulse, 0.0 – 1.0. + * @param {number} strength - The strength of the haptic pulse, range 0.0 – 1.0. * @param {number} duration - The duration of the haptic pulse, in milliseconds. * @param {Controller.Hand} [hand=2] - The hand or hands to trigger the haptic pulse on. * @example Trigger a haptic pulse on the right hand. @@ -224,7 +224,7 @@ namespace controller { /**jsdoc * Triggers a 250ms haptic pulse on connected and enabled devices that have the capability. * @function Controller.triggerShortHapticPulse - * @param {number} strength - The strength of the haptic pulse, 0.0 – 1.0. + * @param {number} strength - The strength of the haptic pulse, range 0.0 – 1.0. * @param {Controller.Hand} [hand=2] - The hand or hands to trigger the haptic pulse on. */ Q_INVOKABLE bool triggerShortHapticPulse(float strength, controller::Hand hand = BOTH) const; @@ -233,7 +233,7 @@ namespace controller { * Triggers a haptic pulse on a particular device if connected and enabled and it has the capability. * @function Controller.triggerHapticPulseOnDevice * @param {number} deviceID - The ID of the device to trigger the haptic pulse on. - * @param {number} strength - The strength of the haptic pulse, 0.0 – 1.0. + * @param {number} strength - The strength of the haptic pulse, range 0.0 – 1.0. * @param {number} duration - The duration of the haptic pulse, in milliseconds. * @param {Controller.Hand} [hand=2] - The hand or hands to trigger the haptic pulse on. * @example Trigger a haptic pulse on an Oculus Touch controller. @@ -250,7 +250,7 @@ namespace controller { * Triggers a 250ms haptic pulse on a particular device if connected and enabled and it has the capability. * @function Controller.triggerShortHapticPulseOnDevice * @param {number} deviceID - The ID of the device to trigger the haptic pulse on. - * @param {number} strength - The strength of the haptic pulse, 0.0 – 1.0. + * @param {number} strength - The strength of the haptic pulse, range 0.0 – 1.0. * @param {Controller.Hand} [hand=2] - The hand or hands to trigger the haptic pulse on. */ Q_INVOKABLE bool triggerShortHapticPulseOnDevice(unsigned int device, float strength, controller::Hand hand = BOTH) diff --git a/libraries/controllers/src/controllers/StandardController.cpp b/libraries/controllers/src/controllers/StandardController.cpp index a7ae1aae98..ece10ecca3 100644 --- a/libraries/controllers/src/controllers/StandardController.cpp +++ b/libraries/controllers/src/controllers/StandardController.cpp @@ -33,8 +33,8 @@ void StandardController::focusOutEvent() { * identifying each output. Read-only.

*

These outputs 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 0.0 or 1.0 for - * button states, the range 0.0 – 1.0 for unidirectional scales, and the range -1.0 – 1.0 - * for bidirectional scales.

+ * button states, the range 0.0 – 1.0 for unidirectional scales, and the range + * -1.0 – 1.0 for bidirectional scales.

*

Each hardware device has a mapping from its outputs to a subset of Controller.Standard items, specified in a * JSON file. For example, * vive.json diff --git a/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h b/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h index b51f484f7d..f0a823a3de 100644 --- a/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h +++ b/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h @@ -84,12 +84,12 @@ class UserInputMapper; /**jsdoc * A route in a {@link Controller.MappingJSON}. * @typedef {object} Controller.MappingJSONRoute - * @property {string|Controller.MappingJSONAxis} from - The name of a {@link Controller.Hardware} property name or an axis - * made from them. If a property name, the leading "Controller.Hardware." can be omitted. - * @property {boolean} [peek=false] - If true then peeking is enabled per {@link RouteObject#peek}. - * @property {boolean} [debug=false] - If true then debug is enabled per {@link RouteObject#debug}. + * @property {string|Controller.MappingJSONAxis} from - The name of a {@link Controller.Hardware} property or an axis made from + * them. If a property name, the leading "Controller.Hardware." can be omitted. + * @property {boolean} [peek=false] - If true, then peeking is enabled per {@link RouteObject#peek}. + * @property {boolean} [debug=false] - If true, then debug is enabled per {@link RouteObject#debug}. * @property {string|string[]} [when=[]] - One or more numeric {@link Controller.Hardware} property names which are evaluated - * as booleans and ANDed together. Prepend with a ! to use the logical NOT of the property value. The leading + * as booleans and ANDed together. Prepend a property name with a ! to do a logical NOT. The leading * "Controller.Hardware." can be omitted from the property names. * @property {Controller.MappingJSONFilter|Controller.MappingJSONFilter[]} [filters=[]] - One or more filters in the route. * @property {string} to - The name of a {@link Controller.Actions} or {@link Controller.Standard} property. The leading diff --git a/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp b/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp index 78dd14868c..0a6c76e456 100755 --- a/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp +++ b/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp @@ -270,7 +270,7 @@ controller::Input KeyboardMouseDevice::InputDevice::makeInput(KeyboardMouseDevic * new x-coordinate value. * MouseYnumbernumberThe mouse y-coordinate changed. The data value is its * new y-coordinate value. - * MouseWheelRightnumbernumberThe mouse wheel rotated left. The data value + * MouseWheelRightnumbernumberThe mouse wheel rotated right. The data value * is the number of units rotated (typically 1.0). * MouseWheelLeftnumbernumberThe mouse wheel rotated left. The data value * is the number of units rotated (typically 1.0).