From cf01d9f1af21d4be2bd7612dabbe134a82a432e2 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 4 Sep 2019 21:04:03 +1200 Subject: [PATCH 1/5] Script.require() JSDoc fixes --- libraries/script-engine/src/ScriptEngine.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h index 7300f52f9b..06085f30fd 100644 --- a/libraries/script-engine/src/ScriptEngine.h +++ b/libraries/script-engine/src/ScriptEngine.h @@ -416,8 +416,10 @@ public: * Provides access to methods or objects provided in an external JavaScript or JSON file. * See {@link https://docs.highfidelity.com/script/js-tips.html} for further details. * @function Script.require - * @param {string} module - The module to use. May be a JavaScript file or the name of a system module such as - * "sppUi". + * @param {string} module - The module to use. May be a JavaScript file, a JSON file, or the name of a system module such + * as "appUi" (i.e., the "appUi.js" system module JavaScript file). + * @returns {object|array} The value assigned to module.exports in the JavaScript file, or the value defined + * in the JSON file. */ Q_INVOKABLE QScriptValue require(const QString& moduleId); From 5624ba6e1458e7d396522f913cfa7b8811fe9592 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 4 Sep 2019 21:05:06 +1200 Subject: [PATCH 2/5] Fix JSDoc for some Controller.Hardware.Vive property names --- plugins/openvr/src/ViveControllerManager.cpp | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/plugins/openvr/src/ViveControllerManager.cpp b/plugins/openvr/src/ViveControllerManager.cpp index c21a9ae4df..8aa7311de4 100644 --- a/plugins/openvr/src/ViveControllerManager.cpp +++ b/plugins/openvr/src/ViveControllerManager.cpp @@ -1319,13 +1319,13 @@ void ViveControllerManager::InputDevice::setConfigFromString(const QString& valu * RXnumbernumberRight stick x-axis scale. * RYnumbernumberRight stick y-axis scale. * LSnumbernumberLeft touch pad pressed. - * LS_CENTERnumbernumberLeft touch pad center pressed. - * LS_XnumbernumberLeft touch pad pressed x-coordinate. - * LS_YnumbernumberLeft touch pad pressed y-coordinate. + * LSCenternumbernumberLeft touch pad center pressed. + * LSXnumbernumberLeft touch pad pressed x-coordinate. + * LSYnumbernumberLeft touch pad pressed y-coordinate. * RSnumbernumberRight touch pad pressed. - * RS_CENTERnumbernumberRight touch pad center pressed. - * RS_XnumbernumberRight touch pad pressed x-coordinate. - * RS_YnumbernumberRight touch pad pressed y-coordinate. + * RSCenternumbernumberRight touch pad center pressed. + * RSXnumbernumberRight touch pad pressed x-coordinate. + * RSYnumbernumberRight touch pad pressed y-coordinate. * LSTouchnumbernumberLeft touch pad is touched. * RSTouchnumbernumberRight touch pad is touched. * Triggers From 4e274347b4d95d209266f2a771a829786600e57f Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 4 Sep 2019 21:05:36 +1200 Subject: [PATCH 3/5] Fix typo in Entities.getAbsoluteJointRotationInObjectFrame() JSDoc --- libraries/entities/src/EntityScriptingInterface.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index ca9108852f..52470e56c4 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -1294,7 +1294,7 @@ public slots: Q_INVOKABLE int getJointParent(const QUuid& entityID, int index); /**jsdoc - * Gets the translation of a joint in a {@link Entities.EntityProperties-Model|Model} entity relative to the entity's + * Gets the rotation of a joint in a {@link Entities.EntityProperties-Model|Model} entity relative to the entity's * position and orientation. * @function Entities.getAbsoluteJointRotationInObjectFrame * @param {Uuid} entityID - The ID of the entity. From 6474705ca2423e0eda6b2231ca704ad8be31b9f1 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 4 Sep 2019 21:06:30 +1200 Subject: [PATCH 4/5] Reformat "supported script types" in Entities and Scripts signals --- libraries/script-engine/src/ScriptEngine.cpp | 4 ++-- libraries/script-engine/src/ScriptEngine.h | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/libraries/script-engine/src/ScriptEngine.cpp b/libraries/script-engine/src/ScriptEngine.cpp index e679e9f6c5..57e9b06f9d 100644 --- a/libraries/script-engine/src/ScriptEngine.cpp +++ b/libraries/script-engine/src/ScriptEngine.cpp @@ -2210,7 +2210,7 @@ void ScriptEngine::loadEntityScript(const EntityItemID& entityID, const QString& /**jsdoc * Triggered when the script starts for a user. See also, {@link Script.entityScriptPreloadFinished}. *

Note: Can only be connected to via this.preload = function (...) { ... } in the entity script.

- *
Available in:Client Entity ScriptsServer Entity Scripts
+ *

Supported Script Types: Client Entity Scripts • Server Entity Scripts

* @function Entities.preload * @param {Uuid} entityID - The ID of the entity that the script is running in. * @returns {Signal} @@ -2416,7 +2416,7 @@ void ScriptEngine::entityScriptContentAvailable(const EntityItemID& entityID, co /**jsdoc * Triggered when the script terminates for a user. *

Note: Can only be connected to via this.unoad = function () { ... } in the entity script.

- *
Available in:Client Entity ScriptsServer Entity Scripts
+ *

Supported Script Types: Client Entity Scripts • Server Entity Scripts

* @function Entities.unload * @param {Uuid} entityID - The ID of the entity that the script is running in. * @returns {Signal} diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h index 06085f30fd..3ffef16844 100644 --- a/libraries/script-engine/src/ScriptEngine.h +++ b/libraries/script-engine/src/ScriptEngine.h @@ -844,7 +844,7 @@ signals: /**jsdoc * Triggered when the script starts for the user. See also, {@link Entities.preload}. - *
Available in:Client Entity ScriptsServer Entity Scripts
+ *

Supported Script Types: Client Entity Scripts • Server Entity Scripts

* @function Script.entityScriptPreloadFinished * @param {Uuid} entityID - The ID of the entity that the script is running in. * @returns {Signal} From 672e61c49d5c4267a29c833d712a36fa21d29c1c Mon Sep 17 00:00:00 2001 From: David Rowe Date: Wed, 4 Sep 2019 21:06:49 +1200 Subject: [PATCH 5/5] Fix typo in Entities.EntityProperties-Material example --- libraries/entities/src/EntityItemProperties.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/entities/src/EntityItemProperties.cpp b/libraries/entities/src/EntityItemProperties.cpp index c16839dc1a..5437ceaab8 100644 --- a/libraries/entities/src/EntityItemProperties.cpp +++ b/libraries/entities/src/EntityItemProperties.cpp @@ -965,7 +965,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const { * // Value overrides entity's "color" property. * albedo: [1.0, 1.0, 0] // Yellow * } - * }), + * }) * }); */