From 42471c539b58742b5a65c3a29343f5aae5775d1d Mon Sep 17 00:00:00 2001 From: milad Date: Thu, 19 Apr 2018 13:40:57 -0700 Subject: [PATCH] initial fixes from ctralt david's comments --- .../AccountServicesScriptingInterface.h | 29 ++++------------ interface/src/scripting/Audio.h | 33 +++++++++++-------- .../src/AssetScriptingInterface.h | 4 +-- 3 files changed, 27 insertions(+), 39 deletions(-) diff --git a/interface/src/scripting/AccountServicesScriptingInterface.h b/interface/src/scripting/AccountServicesScriptingInterface.h index 2cd1de5bf4..929b589cf4 100644 --- a/interface/src/scripting/AccountServicesScriptingInterface.h +++ b/interface/src/scripting/AccountServicesScriptingInterface.h @@ -38,26 +38,10 @@ class AccountServicesScriptingInterface : public QObject { * The AccountServices API contains helper functions related to user connectivity * * @namespace AccountServices - */ - /**jsdoc - * To be completed - * @property {string} AccountServices.username - * @static - */ - /**jsdoc - * To be completed - * @property {bool} AccountServices.loggedIn - * @static - */ - /**jsdoc - * To be completed - * @property {QString} AccountServices.findableBy - * @static - */ - /**jsdoc - * To be completed - * @property {QUrl} AccountServices.metaverseServerURL - * @static + * @property {string} AccountServices.username - To be completed + * @property {boolean} AccountServices.loggedIn - To be completed + * @property {string} AccountServices.findableBy - To be completed + * @property {string} AccountServices.metaverseServerURL - - To be completed */ Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged) Q_PROPERTY(bool loggedIn READ loggedIn NOTIFY loggedInChanged) @@ -79,8 +63,7 @@ public slots: /**jsdoc * To be completed * @function AccountServices.checkAndSignalForAccessToken - * @static - * @returns {bool} + * @returns {boolean} */ bool checkAndSignalForAccessToken(); void logOut(); @@ -133,7 +116,7 @@ signals: /**jsdoc * To be completed * @function AccountServices.loggedInChanged - * @params {bool} loggedIn + * @params {boolean} loggedIn * @returns {Signal} */ void loggedInChanged(bool loggedIn); diff --git a/interface/src/scripting/Audio.h b/interface/src/scripting/Audio.h index 3e5cf0da9b..508fdc4499 100644 --- a/interface/src/scripting/Audio.h +++ b/interface/src/scripting/Audio.h @@ -28,11 +28,11 @@ class Audio : public AudioScriptingInterface { * The Audio API features tools to help control audio contexts and settings. * * @namespace Audio - * @property {bool} muted - To Be Completed - * @property {bool} noiseReduction - To Be Completed - * @property {bool} inputVolume - To Be Completed - * @property {bool} inputLevel - To Be Completed - * @property {QString} context - To Be Completed + * @property {boolean} muted - To Be Completed + * @property {boolean} noiseReduction - To Be Completed + * @property {boolean} inputVolume - To Be Completed + * @property {boolean} inputLevel - To Be Completed + * @property {string} context - To Be Completed * @property {} devices - To Be Completed */ @@ -67,20 +67,20 @@ public: * To Be Completed * @function Audio.setInputDevice * @param {} device - * @param {bool} isHMD + * @param {boolean} isHMD */ Q_INVOKABLE void setInputDevice(const QAudioDeviceInfo& device, bool isHMD); /**jsdoc * To Be Completed * @function Audio.setOutputDevice * @param {} device - * @param {bool} isHMD + * @param {boolean} isHMD */ Q_INVOKABLE void setOutputDevice(const QAudioDeviceInfo& device, bool isHMD); /**jsdoc * To Be Completed * @function Audio.setReverb - * @param {bool} enable + * @param {boolean} enable */ Q_INVOKABLE void setReverb(bool enable); /**jsdoc @@ -110,46 +110,51 @@ signals: /**jsdoc * To Be Completed * @function Audio.nop - * @returns {signal} + * @returns {Signal} */ void nop(); /**jsdoc * To Be Completed * @function Audio.nop * @param {bool} isMuted - * @returns {signal} + * @returns {Signal} */ void mutedChanged(bool isMuted); /**jsdoc * To Be Completed * @function Audio.noiseReductionChanged * @param {bool} isEnabled - * @returns {signal} + * @returns {Signal} */ void noiseReductionChanged(bool isEnabled); /**jsdoc * To Be Completed * @function Audio.inputVolumeChanged * @param {float} volume - * @returns {signal} + * @returns {Signal} */ void inputVolumeChanged(float volume); /**jsdoc * To Be Completed * @function Audio.inputLevelChanged * @param {float} level - * @returns {signal} + * @returns {Signal} */ void inputLevelChanged(float level); /**jsdoc * To Be Completed * @function Audio.contextChanged * @param {string} context - * @returns {signal} + * @returns {Signal} */ void contextChanged(const QString& context); public slots: + /**jsdoc + * To Be Completed + * @function Audio.onContextChanged + * @returns {Signal} + */ void onContextChanged(); private slots: diff --git a/libraries/script-engine/src/AssetScriptingInterface.h b/libraries/script-engine/src/AssetScriptingInterface.h index 5fda6af067..abe2e1eaf1 100644 --- a/libraries/script-engine/src/AssetScriptingInterface.h +++ b/libraries/script-engine/src/AssetScriptingInterface.h @@ -211,14 +211,14 @@ public: /**jsdoc * To be completed * @function Assets.initializeCache - * @returns {bool} + * @returns {boolean} */ Q_INVOKABLE bool initializeCache() { return Parent::initializeCache(); } /**jsdoc * To be completed * @function Assets.canWriteCacheValue * @property {string} url - * @returns {bool} + * @returns {boolean} */ Q_INVOKABLE bool canWriteCacheValue(const QUrl& url); /**jsdoc