From 3a3bfd1463d0b8e774eb29ddf9d463338837829d Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 20 Jul 2019 09:39:34 +1200 Subject: [PATCH] Doc review --- .../src/scripting/WindowScriptingInterface.h | 7 ++--- interface/src/ui/overlays/Overlays.cpp | 26 +++++++++---------- interface/src/ui/overlays/Overlays.h | 14 +++++----- 3 files changed, 24 insertions(+), 23 deletions(-) diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h index b5b7f3c8b9..010f3bcca2 100644 --- a/interface/src/scripting/WindowScriptingInterface.h +++ b/interface/src/scripting/WindowScriptingInterface.h @@ -658,7 +658,8 @@ signals: /**jsdoc * Triggered when you try to visit a domain but are redirected into the error state. * @function Window.redirectErrorStateChanged - * @param {boolean} isInErrorState - If true, the user has been redirected to the error URL. + * @param {boolean} isInErrorState - true if the user has been redirected to the error URL, false + * if they haven't. * @returns {Signal} */ void redirectErrorStateChanged(bool isInErrorState); @@ -666,8 +667,8 @@ signals: /**jsdoc * Triggered when the interstitial mode changes. * @function Window.interstitialModeChanged - * @param {boolean} interstitialMode - The new interstitial mode value. If true, the interstitial graphics are - * displayed when the domain is loading. + * @param {boolean} interstitialMode - true if the interstitial graphics are displayed when the domain is + * loading, false if they are not. * @returns {Signal} */ void interstitialModeChanged(bool interstitialMode); diff --git a/interface/src/ui/overlays/Overlays.cpp b/interface/src/ui/overlays/Overlays.cpp index c6bbca54e3..be371c900b 100644 --- a/interface/src/ui/overlays/Overlays.cpp +++ b/interface/src/ui/overlays/Overlays.cpp @@ -1393,8 +1393,8 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * * *

2D overlays are rendered on the display surface in desktop mode and on the HUD surface in HMD mode. 3D overlays are - * rendered at a position and orientation in-world.

- *

3D overlays are deprecated: Use local {@link Entities} for these instead.

+ * rendered at a position and orientation in-world.

+ *

3D overlays are deprecated. Use local {@link Entities} instead.

* @typedef {string} Overlays.OverlayType */ @@ -1532,7 +1532,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. */ @@ -1580,7 +1580,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. */ @@ -1629,7 +1629,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. */ @@ -1704,7 +1704,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. * * @property {Overlays.Shape} shape=Hexagon - The geometrical shape of the overlay. @@ -1737,7 +1737,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. * * @property {string} url - The URL of the FBX or OBJ model used for the overlay. @@ -1791,7 +1791,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. */ @@ -1835,7 +1835,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. * * @property {string} url - The URL of the image to display. @@ -1881,7 +1881,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. * * @property {string} url - The URL of the web page to display. @@ -1915,7 +1915,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. * * @property {Uuid} endParentID=null - The avatar, entity, or overlay that the end point of the line is parented to. @@ -1991,7 +1991,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. */ @@ -2039,7 +2039,7 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @property {boolean} grabbable=false - true if the overlay can be grabbed, false if it can't be. * @property {Uuid} parentID=null - The avatar, entity, or overlay that the overlay is parented to. * @property {number} parentJointIndex=65535 - Integer value specifying the joint of the entity or avatar that the entity is - * parented to if parentID is set. Use 65535 or -1 to parent to the parents's position and orientation rather + * parented to if parentID is set. Use 65535 or -1 to parent to the parent's position and orientation rather * than a joint. * * @property {number} startAt=0 - The counter-clockwise angle from the overlay's x-axis that drawing starts at, in degrees. diff --git a/interface/src/ui/overlays/Overlays.h b/interface/src/ui/overlays/Overlays.h index e7308cf8b2..739f5ba45a 100644 --- a/interface/src/ui/overlays/Overlays.h +++ b/interface/src/ui/overlays/Overlays.h @@ -171,7 +171,7 @@ public slots: bool editOverlay(const QUuid& id, const QVariant& properties); /**jsdoc - * Edits multiple overlays' (or entities') properties. + * Edits the properties of multiple overlays (or entities). * @function Overlays.editOverlays * @param propertiesById {object.} - An object with overlay (or entity) IDs as keys and * {@link Overlays.OverlayProperties|OverlayProperties} edits to make as values. @@ -312,7 +312,7 @@ public slots: QUuid getOverlayAtPoint(const glm::vec2& point); /**jsdoc - * Gets the value of a 3D overlay's (or entity's) property. + * Gets a specified property value of a 3D overlay (or entity). *

Note: 2D overlays' property values cannot be retrieved.

* @function Overlays.getProperty * @param {Uuid} id - The ID of the 3D overlay (or entity). @@ -332,7 +332,7 @@ public slots: QVariant getProperty(const QUuid& id, const QString& property); /**jsdoc - * Gets the values of a 3D overlay's (or entity's) properties. + * Gets specified property values of a 3D overlay (or entity). *

Note: 2D overlays' property values cannot be retrieved.

* @function Overlays.getProperties * @param {Uuid} id - The ID of the overlay (or entity). @@ -384,9 +384,9 @@ public slots: * @function Overlays.findRayIntersection * @param {PickRay} pickRay - The PickRay to use for finding overlays. * @param {boolean} [precisionPicking=false] - true to pick against precise meshes, false to pick - * against coarse meshes. If true and the intersected entity is a model, the result's + * against coarse meshes. If true and the intersected entity is a model, the result's * extraInfo property includes more information than it otherwise would. - * @param {Array.} [include=[]] - If not empty then the search is restricted to these overlays (and local entities). + * @param {Array.} [include=[]] - If not empty, then the search is restricted to these overlays (and local entities). * @param {Array.} [discard=[]] - Overlays (and local entities) to ignore during the search. * @param {boolean} [visibleOnly=false] - true if only overlays (and local entities) that are * {@link Overlays.OverlayProperties|visible} should be searched. @@ -490,14 +490,14 @@ public slots: QSizeF textSize(const QUuid& id, const QString& text); /**jsdoc - * Gets the width of the Interface window or HUD. + * Gets the width of the Interface window or HUD surface. * @function Overlays.width * @returns {number} The width, in pixels, of the Interface window if in desktop mode or the HUD surface if in HMD mode. */ float width(); /**jsdoc - * Gets the height of the Interface window or HUD. + * Gets the height of the Interface window or HUD surface. * @function Overlays.height * @returns {number} The height, in pixels, of the Interface window if in desktop mode or the HUD surface if in HMD mode. */