From eff97d48d3d5e2e9d59ade3fcdbe088f5ccc8ca0 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 27 Apr 2019 10:34:06 +1200 Subject: [PATCH] Doc review --- interface/src/scripting/HMDScriptingInterface.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/interface/src/scripting/HMDScriptingInterface.h b/interface/src/scripting/HMDScriptingInterface.h index d542762c64..c6202d4105 100644 --- a/interface/src/scripting/HMDScriptingInterface.h +++ b/interface/src/scripting/HMDScriptingInterface.h @@ -1,4 +1,4 @@ - +// // HMDScriptingInterface.h // interface/src/scripting // @@ -197,7 +197,7 @@ public: * Checks whether there is an HMD available. * @function HMD.isHMDAvailable * @param {string} [name=""] - The name of the HMD to check for, e.g., "Oculus Rift". The name is the same as - * may be displayed in Interface's "Display" menu. If no name is specified then any HMD matches. + * may be displayed in Interface's "Display" menu. If no name is specified, then any HMD matches. * @returns {boolean} true if an HMD of the specified name is available, otherwise * false. * @example Report on HMD availability. @@ -211,7 +211,7 @@ public: * Checks whether there is an HMD head controller available. * @function HMD.isHeadControllerAvailable * @param {string} [name=""] - The name of the HMD head controller to check for, e.g., "Oculus". If no name is - * specified then any HMD head controller matches. + * specified, then any HMD head controller matches. * @returns {boolean} true if an HMD head controller of the specified name is available, * otherwise false. * @example Report HMD head controller availability. @@ -225,7 +225,7 @@ public: * Checks whether there are HMD hand controllers available. * @function HMD.isHandControllerAvailable * @param {string} [name=""] - The name of the HMD hand controller to check for, e.g., "Oculus". If no name is - * specified then any HMD hand controller matches. + * specified, then any HMD hand controller matches. * @returns {boolean} true if an HMD hand controller of the specified name is available, * otherwise false. * @example Report HMD hand controller availability. @@ -293,7 +293,7 @@ public: /**jsdoc * Suppresses the activation of the HMD-provided keyboard, if any. Successful calls should be balanced with a call to - * {@link HMD.unspressKeyboard|unspressKeyboard} within a reasonable amount of time. + * {@link HMD.unsuppressKeyboard|unsuppressKeyboard} within a reasonable amount of time. * @function HMD.suppressKeyboard * @returns {boolean} true if the current HMD provides a keyboard and it was successfully suppressed (e.g., it * isn't being displayed), otherwise false.