From c6fd726111953e484e7829e0f85fc20f44bffaaf Mon Sep 17 00:00:00 2001 From: David Rowe Date: Tue, 2 Jul 2019 16:07:39 +1200 Subject: [PATCH] Typos etc. --- interface/src/raypick/PointerScriptingInterface.cpp | 3 ++- interface/src/raypick/PointerScriptingInterface.h | 8 ++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/interface/src/raypick/PointerScriptingInterface.cpp b/interface/src/raypick/PointerScriptingInterface.cpp index d904706b08..5bff7d4589 100644 --- a/interface/src/raypick/PointerScriptingInterface.cpp +++ b/interface/src/raypick/PointerScriptingInterface.cpp @@ -54,7 +54,8 @@ unsigned int PointerScriptingInterface::createPointer(const PickQuery::PickType& * The properties of a stylus pointer. These include the properties from the underlying stylus pick that the pointer uses. * @typedef {object} Pointers.StylusPointerProperties * @property {Pointers.StylusPointerModel} [model] - Override some or all of the default stylus model properties. - * @property {boolean} [hover=false] - If true, the pointer generates {@link Entities} hover events. + * @property {boolean} [hover=false] - true if the pointer generates {@link Entities} hover events, + * false if it doesn't. * @see {@link Picks.StylusPickProperties} for additional properties from the underlying stylus pick. */ /**jsdoc diff --git a/interface/src/raypick/PointerScriptingInterface.h b/interface/src/raypick/PointerScriptingInterface.h index 58959570ab..823767467e 100644 --- a/interface/src/raypick/PointerScriptingInterface.h +++ b/interface/src/raypick/PointerScriptingInterface.h @@ -53,7 +53,7 @@ public: */ /**jsdoc - * Creates a new ray, parabola, or stylus pointer. The pointers can have a wide range of behaviors depending on the + * Creates a new ray, parabola, or stylus pointer. The pointer can have a wide range of behaviors depending on the * properties specified. For example, a ray pointer may be a static ray pointer, a mouse ray pointer, or joint ray * pointer. *

Warning: Pointers created using this method currently always intersect at least visible and @@ -306,11 +306,11 @@ public: /**jsdoc - * Gets the most recent pick result from a pointer. A pointer continues to be updated ready to return a result, as long as + * Gets the most recent intersection of a pointer. A pointer continues to be updated ready to return a result, as long as * it is enabled, regardless of the render state. * @function Pointers.getPrevPickResult * @param {number} id - The ID of the pointer. - * @returns {RayPickResult|ParabolaPickResult|StylusPickResult} The most recent intersection result. + * @returns {RayPickResult|ParabolaPickResult|StylusPickResult} The most recent intersection of the pointer. */ Q_INVOKABLE QVariantMap getPrevPickResult(unsigned int uid) const; @@ -399,7 +399,7 @@ public: * Gets information about a pointer. * @function Pointers.getPointerProperties * @param {number} id - The ID of the pointer. - * @returns {Pointers.RayPointerProperties|Pointers.ParabolaPointerProperties|{}} The renderStates and + * @returns {Pointers.RayPointerProperties|Pointers.ParabolaPointerProperties|object} The renderStates and * defaultRenderStates for ray and parabola pointers, {} for stylus pointers. * @example Report the properties of a parabola pointer. * var intersectEnd = {