From 23d07fa2929d7f3e62ab3cde973840fd3136d09c Mon Sep 17 00:00:00 2001 From: milad nazeri Date: Tue, 24 Apr 2018 13:14:55 -0700 Subject: [PATCH] fixed spacing issue --- interface/src/AvatarBookmarks.h | 14 +- interface/src/Bookmarks.h | 8 +- interface/src/LODManager.h | 132 ++++---- interface/src/audio/AudioScope.h | 172 +++++----- interface/src/avatar/AvatarManager.h | 181 +++++----- interface/src/devices/DdeFaceTracker.h | 16 +- .../AccountServicesScriptingInterface.h | 88 ++--- interface/src/scripting/Audio.h | 114 +++---- .../scripting/GooglePolyScriptingInterface.h | 92 +++--- interface/src/ui/AvatarInputs.h | 62 ++-- libraries/animation/src/AnimationCache.h | 104 +++--- libraries/audio-client/src/AudioIOStats.h | 116 +++---- libraries/audio/src/SoundCache.h | 113 ++++--- libraries/avatars/src/AvatarHashMap.h | 96 +++--- .../src/model-networking/TextureCache.h | 110 +++---- libraries/networking/src/ResourceCache.h | 104 +++--- .../src/AssetScriptingInterface.h | 310 +++++++++--------- libraries/trackers/src/trackers/FaceTracker.h | 22 +- 18 files changed, 926 insertions(+), 928 deletions(-) diff --git a/interface/src/AvatarBookmarks.h b/interface/src/AvatarBookmarks.h index 2e5d2c3de5..228d78333a 100644 --- a/interface/src/AvatarBookmarks.h +++ b/interface/src/AvatarBookmarks.h @@ -16,8 +16,8 @@ #include "Bookmarks.h" /**jsdoc -* This API helps manage adding and deleting Avatar bookmarks -*/ + * This API helps manage adding and deleting Avatar bookmarks + */ class AvatarBookmarks: public Bookmarks, public Dependency { Q_OBJECT @@ -28,13 +28,13 @@ public: void setupMenus(Menu* menubar, MenuWrapper* menu) override; /**jsdoc -* Add the current Avatar to your Avatar Bookmarks -* @function AvatarBookmarks.addBookMark -*/ + * Add the current Avatar to your Avatar Bookmarks + * @function AvatarBookmarks.addBookMark + */ /**jsdoc -* @function AvatarBookmarks.deleteBookMark -*/ + * @function AvatarBookmarks.deleteBookMark + */ public slots: void addBookmark(); diff --git a/interface/src/Bookmarks.h b/interface/src/Bookmarks.h index e3e34d922c..99e5911591 100644 --- a/interface/src/Bookmarks.h +++ b/interface/src/Bookmarks.h @@ -1,4 +1,4 @@ -// + // // Bookmarks.h // interface/src // @@ -49,9 +49,9 @@ protected: protected slots: /**jsdoc - * Delete - * @function AvatarBookmarks.deleteBookmark - */ + * Delete + * @function AvatarBookmarks.deleteBookmark + */ void deleteBookmark(); private: diff --git a/interface/src/LODManager.h b/interface/src/LODManager.h index 72a3dfbcbc..fa87a6c61b 100644 --- a/interface/src/LODManager.h +++ b/interface/src/LODManager.h @@ -10,9 +10,9 @@ // /**jsdoc -* The LOD class manages your Level of Detail functions within interface -* @namespace LODManager -*/ + * The LOD class manages your Level of Detail functions within interface + * @namespace LODManager + */ #ifndef hifi_LODManager_h #define hifi_LODManager_h @@ -46,122 +46,122 @@ class LODManager : public QObject, public Dependency { public: /**jsdoc - * @function LODManager.setAutomaticLODAdjust - * @param {boolean} value - */ + * @function LODManager.setAutomaticLODAdjust + * @param {boolean} value + */ Q_INVOKABLE void setAutomaticLODAdjust(bool value) { _automaticLODAdjust = value; } /**jsdoc - * @function LODManager.getAutomaticLODAdjust - * @returns {boolean} - */ + * @function LODManager.getAutomaticLODAdjust + * @returns {boolean} + */ Q_INVOKABLE bool getAutomaticLODAdjust() const { return _automaticLODAdjust; } /**jsdoc - * @function LODManager.setDesktopLODDecreaseFPS - * @param {float} value - */ + * @function LODManager.setDesktopLODDecreaseFPS + * @param {float} value + */ Q_INVOKABLE void setDesktopLODDecreaseFPS(float value); /**jsdoc - * @function LODManager.getDesktopLODDecreaseFPS - * @returns {number} - */ + * @function LODManager.getDesktopLODDecreaseFPS + * @returns {number} + */ Q_INVOKABLE float getDesktopLODDecreaseFPS() const; /**jsdoc - * @function LODManager.getDesktopLODIncreaseFPS - * @returns {number} - */ + * @function LODManager.getDesktopLODIncreaseFPS + * @returns {number} + */ Q_INVOKABLE float getDesktopLODIncreaseFPS() const; /**jsdoc - * @function LODManager.setHMDLODDecreaseFPS - * @param {number} value - */ - + * @function LODManager.setHMDLODDecreaseFPS + * @param {number} value + */ + Q_INVOKABLE void setHMDLODDecreaseFPS(float value); /**jsdoc - * @function LODManager.getHMDLODDecreaseFPS - * @returns {number} - */ + * @function LODManager.getHMDLODDecreaseFPS + * @returns {number} + */ Q_INVOKABLE float getHMDLODDecreaseFPS() const; /**jsdoc - * @function LODManager.getHMDLODIncreaseFPS - * @returns {number} - */ - + * @function LODManager.getHMDLODIncreaseFPS + * @returns {number} + */ + Q_INVOKABLE float getHMDLODIncreaseFPS() const; // User Tweakable LOD Items /**jsdoc - * @function LODManager.getLODFeedbackText - * @returns {string} - */ + * @function LODManager.getLODFeedbackText + * @returns {string} + */ Q_INVOKABLE QString getLODFeedbackText(); /**jsdoc - * @function LODManager.setOctreeSizeScale - * @param {number} sizeScale - */ + * @function LODManager.setOctreeSizeScale + * @param {number} sizeScale + */ Q_INVOKABLE void setOctreeSizeScale(float sizeScale); /**jsdoc - * @function LODManager.getOctreeSizeScale - * @returns {number} - */ + * @function LODManager.getOctreeSizeScale + * @returns {number} + */ Q_INVOKABLE float getOctreeSizeScale() const { return _octreeSizeScale; } /**jsdoc - * @function LODManager.setBoundaryLevelAdjust - * @param {number} boundaryLevelAdjust - */ + * @function LODManager.setBoundaryLevelAdjust + * @param {number} boundaryLevelAdjust + */ Q_INVOKABLE void setBoundaryLevelAdjust(int boundaryLevelAdjust); /**jsdoc - * @function LODManager.getBoundaryLevelAdjust - * @returns {number} - */ + * @function LODManager.getBoundaryLevelAdjust + * @returns {number} + */ Q_INVOKABLE int getBoundaryLevelAdjust() const { return _boundaryLevelAdjust; } /**jsdoc - * @function LODManager.getLODDecreaseFPS - * @returns {number} - */ + * @function LODManager.getLODDecreaseFPS + * @returns {number} + */ Q_INVOKABLE float getLODDecreaseFPS() const; /**jsdoc - * @function LODManager.getLODIncreaseFPS - * @returns {number} - */ + * @function LODManager.getLODIncreaseFPS + * @returns {number} + */ Q_INVOKABLE float getLODIncreaseFPS() const; /**jsdoc - * @namespace LODManager - * @property presentTime {number} - * @property engineRunTime {number} - * @property gpuTime {number} - * @property avgRenderTime {number} - * @property fps {number} - * @property lodLevel {number} - * @property lodDecreaseFPS {number} - * @property lodIncreaseFPS {number} - */ + * @namespace LODManager + * @property presentTime {number} + * @property engineRunTime {number} + * @property gpuTime {number} + * @property avgRenderTime {number} + * @property fps {number} + * @property lodLevel {number} + * @property lodDecreaseFPS {number} + * @property lodIncreaseFPS {number} + */ Q_PROPERTY(float presentTime READ getPresentTime) Q_PROPERTY(float engineRunTime READ getEngineRunTime) @@ -192,16 +192,16 @@ public: signals: /**jsdoc - * @function LODManager.LODIncreased - * @returns {Signal} - */ + * @function LODManager.LODIncreased + * @returns {Signal} + */ void LODIncreased(); /**jsdoc - * @function LODManager.LODDecreased - * @returns {Signal} - */ + * @function LODManager.LODDecreased + * @returns {Signal} + */ void LODDecreased(); diff --git a/interface/src/audio/AudioScope.h b/interface/src/audio/AudioScope.h index 6ff23a3702..4fde25ecb8 100644 --- a/interface/src/audio/AudioScope.h +++ b/interface/src/audio/AudioScope.h @@ -26,15 +26,15 @@ class AudioScope : public QObject, public Dependency { SINGLETON_DEPENDENCY /**jsdoc - * The AudioScope API helps control the Audio Scope features in Interface - * @namespace AudioScope - * @property {int} scopeInput - * @property {int} scopeOutputLeft - * @property {int} scopeOutputRight - * @property {int} triggerInput - * @property {int} triggerOutputLeft - * @property {int} triggerOutputRight - */ + * The AudioScope API helps control the Audio Scope features in Interface + * @namespace AudioScope + * @property {int} scopeInput + * @property {int} scopeOutputLeft + * @property {int} scopeOutputRight + * @property {int} triggerInput + * @property {int} triggerOutputLeft + * @property {int} triggerOutputRight + */ Q_PROPERTY(QVector scopeInput READ getScopeInput) Q_PROPERTY(QVector scopeOutputLeft READ getScopeOutputLeft) @@ -53,189 +53,189 @@ public: public slots: /**jsdoc - * @function AudioScope.toggle - */ + * @function AudioScope.toggle + */ void toggle() { setVisible(!_isEnabled); } /**jsdoc - * @function AudioScope.setVisible - * @param {boolean} visible - */ + * @function AudioScope.setVisible + * @param {boolean} visible + */ void setVisible(bool visible); /**jsdoc - * @function AudioScope.getVisible - * @param {boolean} visible - * @returns {boolean} - */ + * @function AudioScope.getVisible + * @param {boolean} visible + * @returns {boolean} + */ bool getVisible() const { return _isEnabled; } /**jsdoc - * @function AudioScope.togglePause - */ + * @function AudioScope.togglePause + */ void togglePause() { setPause(!_isPaused); } /**jsdoc - * @function AudioScope.setPause - * @param {boolean} - */ + * @function AudioScope.setPause + * @param {boolean} + */ void setPause(bool paused) { _isPaused = paused; emit pauseChanged(); } /**jsdoc - * @function AudioScope.getPause - * @returns {boolean} - */ + * @function AudioScope.getPause + * @returns {boolean} + */ bool getPause() { return _isPaused; } /**jsdoc - * @function AudioScope.toggleTrigger - */ + * @function AudioScope.toggleTrigger + */ void toggleTrigger() { _autoTrigger = !_autoTrigger; } /**jsdoc - * @function AudioScope.getAutoTrigger - * @returns {boolean} - */ + * @function AudioScope.getAutoTrigger + * @returns {boolean} + */ bool getAutoTrigger() { return _autoTrigger; } /**jsdoc - * @function AudioScope.setAutoTrigger - * @param {boolean} autoTrigger - */ + * @function AudioScope.setAutoTrigger + * @param {boolean} autoTrigger + */ void setAutoTrigger(bool autoTrigger) { _isTriggered = false; _autoTrigger = autoTrigger; } /**jsdoc - * @function AudioScope.setTriggerValues - * @param {number} x - * @param {number} y - */ + * @function AudioScope.setTriggerValues + * @param {number} x + * @param {number} y + */ void setTriggerValues(int x, int y) { _triggerValues.x = x; _triggerValues.y = y; } /**jsdoc - * @function AudioScope.setTriggered - * @param {boolean} triggered - */ + * @function AudioScope.setTriggered + * @param {boolean} triggered + */ void setTriggered(bool triggered) { _isTriggered = triggered; } /**jsdoc - * @function AudioScope.getTriggered - * @returns {boolean} - */ + * @function AudioScope.getTriggered + * @returns {boolean} + */ bool getTriggered() { return _isTriggered; } /**jsdoc - * @function AudioScope.getFramesPerSecond - * @returns {number} - */ + * @function AudioScope.getFramesPerSecond + * @returns {number} + */ float getFramesPerSecond(); /**jsdoc - * @function AudioScope.getFramesPerScope - * @returns {number} - */ + * @function AudioScope.getFramesPerScope + * @returns {number} + */ int getFramesPerScope() { return _framesPerScope; } /**jsdoc - * @function AudioScope.selectAudioScopeFiveFrames - */ + * @function AudioScope.selectAudioScopeFiveFrames + */ void selectAudioScopeFiveFrames(); /**jsdoc - * @function AudioScope.selectAudioScopeTwentyFrames - */ + * @function AudioScope.selectAudioScopeTwentyFrames + */ void selectAudioScopeTwentyFrames(); /**jsdoc - * @function AudioScope.selectAudioScopeFiftyFrames - */ + * @function AudioScope.selectAudioScopeFiftyFrames + */ void selectAudioScopeFiftyFrames(); /**jsdoc - * @function AudioScope.getScopeInput - * @returns {number} - */ + * @function AudioScope.getScopeInput + * @returns {number} + */ QVector getScopeInput() { return _scopeInputData; }; /**jsdoc - * @function AudioScope.getScopeOutputLeft - * @returns {number} - */ + * @function AudioScope.getScopeOutputLeft + * @returns {number} + */ QVector getScopeOutputLeft() { return _scopeOutputLeftData; }; /**jsdoc - * @function AudioScope.getScopeOutputRight - * @returns {number} - */ + * @function AudioScope.getScopeOutputRight + * @returns {number} + */ QVector getScopeOutputRight() { return _scopeOutputRightData; }; /**jsdoc - * @function AudioScope.getTriggerInput - * @returns {number} - */ + * @function AudioScope.getTriggerInput + * @returns {number} + */ QVector getTriggerInput() { return _triggerInputData; }; /**jsdoc - * @function AudioScope.getTriggerOutputLeft - * @returns {number} - */ + * @function AudioScope.getTriggerOutputLeft + * @returns {number} + */ QVector getTriggerOutputLeft() { return _triggerOutputLeftData; }; /**jsdoc - * @function AudioScope.getTriggerOutputRight - * @returns {number} - */ + * @function AudioScope.getTriggerOutputRight + * @returns {number} + */ QVector getTriggerOutputRight() { return _triggerOutputRightData; }; /**jsdoc - * @function AudioScope.setLocalEcho - * @parm {boolean} serverEcho - */ + * @function AudioScope.setLocalEcho + * @parm {boolean} serverEcho + */ void setLocalEcho(bool serverEcho); /**jsdoc - * @function AudioScope.setServerEcho - * @parm {boolean} serverEcho - */ + * @function AudioScope.setServerEcho + * @parm {boolean} serverEcho + */ void setServerEcho(bool serverEcho); signals: /**jsdoc - * @function AudioScope.pauseChanged - * @returns {Signal} - */ + * @function AudioScope.pauseChanged + * @returns {Signal} + */ void pauseChanged(); /**jsdoc - * @function AudioScope.triggered - * @returns {Signal} - */ + * @function AudioScope.triggered + * @returns {Signal} + */ void triggered(); diff --git a/interface/src/avatar/AvatarManager.h b/interface/src/avatar/AvatarManager.h index 9e77c77ee2..cdbdbf2756 100644 --- a/interface/src/avatar/AvatarManager.h +++ b/interface/src/avatar/AvatarManager.h @@ -28,9 +28,9 @@ #include "MyAvatar.h" /**jsdoc -* The AvatarManager API has properties and methods which manage Avatars within the same domain. -* @namespace AvatarManager -*/ + * The AvatarManager API has properties and methods which manage Avatars within the same domain. + * @namespace AvatarManager + */ class AvatarManager : public AvatarHashMap { Q_OBJECT @@ -41,71 +41,71 @@ public: // JSDOCS Copied over from AvatarHashMap (see AvatarHashMap.h for reason) /**jsdoc - * @function AvatarManager.getAvatarIdentifiers - */ + * @function AvatarManager.getAvatarIdentifiers + */ /**jsdoc - * @function AvatarManager.getAvatarsInRange - * @param {Vec3} position - * @param {float} rangeMeters - * @returns {string[]} - */ + * @function AvatarManager.getAvatarsInRange + * @param {Vec3} position + * @param {float} rangeMeters + * @returns {string[]} + */ /**jsdoc - * @function AvatarManager.getAvatar - * @param {string} avatarID - * @returns {ScriptAvatarData} - */ + * @function AvatarManager.getAvatar + * @param {string} avatarID + * @returns {ScriptAvatarData} + */ /**jsdoc - * @function AvatarManager.avatarAddedEvent - * @param {string} sessionUUID - * @returns {Signal} - */ + * @function AvatarManager.avatarAddedEvent + * @param {string} sessionUUID + * @returns {Signal} + */ /**jsdoc - * @function AvatarManager.avatarRemovedEvent - * @param {string} sessionUUID - * @returns {Signal} - */ + * @function AvatarManager.avatarRemovedEvent + * @param {string} sessionUUID + * @returns {Signal} + */ /**jsdoc - * @function AvatarManager.avatarSessionChangedEvent - * @param {string} sessionUUID - * @param {string} oldUUID - * @returns {Signal} - */ + * @function AvatarManager.avatarSessionChangedEvent + * @param {string} sessionUUID + * @param {string} oldUUID + * @returns {Signal} + */ /**jsdoc - * @function AvatarManager.isAvatarInRange - * @param {string} position - * @param {string} range - * @returns {boolean} - */ + * @function AvatarManager.isAvatarInRange + * @param {string} position + * @param {string} range + * @returns {boolean} + */ /**jsdoc - * @function AvatarManager.sessionUUIDChanged - * @param {string} sessionUUID - * @param {string} oldUUID - */ + * @function AvatarManager.sessionUUIDChanged + * @param {string} sessionUUID + * @param {string} oldUUID + */ /**jsdoc - * @function AvatarManager.processAvatarDataPacket - * @param {} message - * @param {} sendingNode - */ + * @function AvatarManager.processAvatarDataPacket + * @param {} message + * @param {} sendingNode + */ /**jsdoc - * @function AvatarManager.processAvatarIdentityPacket - * @param {} message - * @param {} sendingNode - */ + * @function AvatarManager.processAvatarIdentityPacket + * @param {} message + * @param {} sendingNode + */ /**jsdoc - * @function AvatarManager.processKillAvatar - * @param {} message - * @param {} sendingNode - */ + * @function AvatarManager.processKillAvatar + * @param {} message + * @param {} sendingNode + */ /// Registers the script types associated with the avatar manager. static void registerMetaTypes(QScriptEngine* engine); @@ -118,10 +118,10 @@ public: glm::vec3 getMyAvatarPosition() const { return _myAvatar->getWorldPosition(); } /**jsdoc - * @function AvatarManager.getAvatar - * @param {string} avatarID - * @returns {} - */ + * @function AvatarManager.getAvatar + * @param {string} avatarID + * @returns {} + */ // Null/Default-constructed QUuids will return MyAvatar Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) override { return new ScriptAvatar(getAvatarBySessionID(avatarID)); } @@ -147,51 +147,50 @@ public: void handleCollisionEvents(const CollisionEvents& collisionEvents); /**jsdoc - * @function AvatarManager.getAvatarDataRate - * @param {string} sessionID - * @param {string} rateName - * @returns {number} - */ + * @function AvatarManager.getAvatarDataRate + * @param {string} sessionID + * @param {string} rateName + * @returns {number} + */ Q_INVOKABLE float getAvatarDataRate(const QUuid& sessionID, const QString& rateName = QString("")) const; /**jsdoc - * @function AvatarManager.getAvatarUpdateRate - * @param {string} sessionID - * @param {string} rateName - * @returns {number} - */ + * @function AvatarManager.getAvatarUpdateRate + * @param {string} sessionID + * @param {string} rateName + * @returns {number} + */ Q_INVOKABLE float getAvatarUpdateRate(const QUuid& sessionID, const QString& rateName = QString("")) const; /**jsdoc - * @function AvatarManager.getAvatarSimulationRate - * @param {string} sessionID - * @param {string} rateName - * @returns {number} - */ + * @function AvatarManager.getAvatarSimulationRate + * @param {string} sessionID + * @param {string} rateName + * @returns {number} + */ Q_INVOKABLE float getAvatarSimulationRate(const QUuid& sessionID, const QString& rateName = QString("")) const; /**jsdoc - * @function AvatarManager.findRayIntersection - * @param {PickRay} ray - * @param {} avatarIdsToInclude - * @param {} avatarIdsToDiscard - * @returns {RayToAvatarIntersectionResult} - */ + * @function AvatarManager.findRayIntersection + * @param {PickRay} ray + * @param {} avatarIdsToInclude + * @param {} avatarIdsToDiscard + * @returns {RayToAvatarIntersectionResult} + */ Q_INVOKABLE RayToAvatarIntersectionResult findRayIntersection(const PickRay& ray, const QScriptValue& avatarIdsToInclude = QScriptValue(), const QScriptValue& avatarIdsToDiscard = QScriptValue()); /**jsdoc - * To Be Completed - * @function AvatarManager.findRayIntersectionVector - * @param {PickRay} ray - * @param {} avatarsToInclude - * @param {} avatarIdsToDiscard - * @returns {RayToAvatarIntersectionResult} - */ + * @function AvatarManager.findRayIntersectionVector + * @param {PickRay} ray + * @param {} avatarsToInclude + * @param {} avatarIdsToDiscard + * @returns {RayToAvatarIntersectionResult} + */ Q_INVOKABLE RayToAvatarIntersectionResult findRayIntersectionVector(const PickRay& ray, const QVector& avatarsToInclude, @@ -199,18 +198,18 @@ public: // TODO: remove this HACK once we settle on optimal default sort coefficients /**jsdoc - * @function AvatarManager.getAvatarSortCoefficient - * @param {string} name - * @returns {number} - */ + * @function AvatarManager.getAvatarSortCoefficient + * @param {string} name + * @returns {number} + */ Q_INVOKABLE float getAvatarSortCoefficient(const QString& name); /**jsdoc - * @function AvatarManager.setAvatarSortCoefficient - * @param {string} name - * @param {string} value - */ + * @function AvatarManager.setAvatarSortCoefficient + * @param {string} name + * @param {string} value + */ Q_INVOKABLE void setAvatarSortCoefficient(const QString& name, const QScriptValue& value); @@ -219,9 +218,9 @@ public: public slots: /**jsdoc - * @function AvatarManager.updateAvatarRenderStatus - * @param {boolean} shouldRenderAvatars - */ + * @function AvatarManager.updateAvatarRenderStatus + * @param {boolean} shouldRenderAvatars + */ void updateAvatarRenderStatus(bool shouldRenderAvatars); diff --git a/interface/src/devices/DdeFaceTracker.h b/interface/src/devices/DdeFaceTracker.h index 072dc3c226..37ebf9159d 100644 --- a/interface/src/devices/DdeFaceTracker.h +++ b/interface/src/devices/DdeFaceTracker.h @@ -27,9 +27,9 @@ #include /**jsdoc -* The FaceTracker API helps manage facial tracking hardware. -* @namespace FaceTracker -*/ + * The FaceTracker API helps manage facial tracking hardware. + * @namespace FaceTracker + */ class DdeFaceTracker : public FaceTracker, public Dependency { Q_OBJECT @@ -64,15 +64,15 @@ public: public slots: /**jsdoc - * @function FaceTracker.setEnabled - * @param {boolean} enabled - */ + * @function FaceTracker.setEnabled + * @param {boolean} enabled + */ void setEnabled(bool enabled) override; /**jsdoc - * @function FaceTracker.calibrate - */ + * @function FaceTracker.calibrate + */ void calibrate(); diff --git a/interface/src/scripting/AccountServicesScriptingInterface.h b/interface/src/scripting/AccountServicesScriptingInterface.h index aca447673c..65c083b8e4 100644 --- a/interface/src/scripting/AccountServicesScriptingInterface.h +++ b/interface/src/scripting/AccountServicesScriptingInterface.h @@ -36,14 +36,14 @@ class AccountServicesScriptingInterface : public QObject { Q_OBJECT /**jsdoc - * The AccountServices API contains helper functions related to user connectivity - * - * @namespace AccountServices - * @property {string} username - * @property {boolean} loggedIn - * @property {string} findableBy - * @property {string} metaverseServerURL - */ + * The AccountServices API contains helper functions related to user connectivity + * + * @namespace AccountServices + * @property {string} username + * @property {boolean} loggedIn + * @property {string} findableBy + * @property {string} metaverseServerURL + */ Q_PROPERTY(QString username READ getUsername NOTIFY myUsernameChanged) Q_PROPERTY(bool loggedIn READ loggedIn NOTIFY loggedInChanged) @@ -60,35 +60,35 @@ public: public slots: /**jsdoc - * @function AccountServices.getDownloadInfo - * @returns {DownloadInfoResult} - */ + * @function AccountServices.getDownloadInfo + * @returns {DownloadInfoResult} + */ DownloadInfoResult getDownloadInfo(); /**jsdoc - * @function AccountServices.updateDownloadInfo - */ + * @function AccountServices.updateDownloadInfo + */ void updateDownloadInfo(); /**jsdoc - * @function AccountServices.isLoggedIn - * @returns {boolean} - */ + * @function AccountServices.isLoggedIn + * @returns {boolean} + */ bool isLoggedIn(); /**jsdoc - * @function AccountServices.checkAndSignalForAccessToken - * @returns {boolean} - */ + * @function AccountServices.checkAndSignalForAccessToken + * @returns {boolean} + */ bool checkAndSignalForAccessToken(); /**jsdoc - * @function AccountServices.logOut - */ + * @function AccountServices.logOut + */ void logOut(); @@ -105,49 +105,49 @@ private slots: signals: /**jsdoc - * @function AccountServices.connected - * @returns {Signal} - */ + * @function AccountServices.connected + * @returns {Signal} + */ void connected(); /**jsdoc - * @function AccountServices.disconnected - * @params {string} reason - * @returns {Signal} - */ + * @function AccountServices.disconnected + * @params {string} reason + * @returns {Signal} + */ void disconnected(const QString& reason); /**jsdoc - * @function AccountServices.myUsernameChanged - * @params {string} username - * @returns {Signal} - */ + * @function AccountServices.myUsernameChanged + * @params {string} username + * @returns {Signal} + */ void myUsernameChanged(const QString& username); /**jsdoc - * @function AccountServices.downloadInfoChanged - * @params {} info - * @returns {Signal} - */ + * @function AccountServices.downloadInfoChanged + * @params {} info + * @returns {Signal} + */ void downloadInfoChanged(DownloadInfoResult info); /**jsdoc - * @function AccountServices.findableByChanged - * @params {string} discoverabilityMode - * @returns {Signal} - */ + * @function AccountServices.findableByChanged + * @params {string} discoverabilityMode + * @returns {Signal} + */ void findableByChanged(const QString& discoverabilityMode); /**jsdoc - * @function AccountServices.loggedInChanged - * @params {boolean} loggedIn - * @returns {Signal} - */ + * @function AccountServices.loggedInChanged + * @params {boolean} loggedIn + * @returns {Signal} + */ void loggedInChanged(bool loggedIn); diff --git a/interface/src/scripting/Audio.h b/interface/src/scripting/Audio.h index 5e40b53fba..b3f6ea0987 100644 --- a/interface/src/scripting/Audio.h +++ b/interface/src/scripting/Audio.h @@ -25,16 +25,16 @@ class Audio : public AudioScriptingInterface { SINGLETON_DEPENDENCY /**jsdoc - * The Audio API features tools to help control audio contexts and settings. - * - * @namespace Audio - * @property {boolean} muted - * @property {boolean} noiseReduction - * @property {boolean} inputVolume - * @property {boolean} inputLevel - * @property {string} context - * @property {} devices - */ + * The Audio API features tools to help control audio contexts and settings. + * + * @namespace Audio + * @property {boolean} muted + * @property {boolean} noiseReduction + * @property {boolean} inputVolume + * @property {boolean} inputLevel + * @property {string} context + * @property {} devices + */ Q_PROPERTY(bool muted READ isMuted WRITE setMuted NOTIFY mutedChanged) Q_PROPERTY(bool noiseReduction READ noiseReductionEnabled WRITE enableNoiseReduction NOTIFY noiseReductionChanged) @@ -64,109 +64,109 @@ public: void setInputVolume(float volume); /**jsdoc - * @function Audio.setInputDevice - * @param {} device - * @param {boolean} isHMD - */ + * @function Audio.setInputDevice + * @param {} device + * @param {boolean} isHMD + */ Q_INVOKABLE void setInputDevice(const QAudioDeviceInfo& device, bool isHMD); /**jsdoc - * @function Audio.setOutputDevice - * @param {} device - * @param {boolean} isHMD - */ + * @function Audio.setOutputDevice + * @param {} device + * @param {boolean} isHMD + */ Q_INVOKABLE void setOutputDevice(const QAudioDeviceInfo& device, bool isHMD); /**jsdoc - * @function Audio.setReverb - * @param {boolean} enable - */ + * @function Audio.setReverb + * @param {boolean} enable + */ Q_INVOKABLE void setReverb(bool enable); /**jsdoc - * @function Audio.setReverbOptions - * @param {} options - */ + * @function Audio.setReverbOptions + * @param {} options + */ Q_INVOKABLE void setReverbOptions(const AudioEffectOptions* options); /**jsdoc - * @function Audio.setReverbOptions - * @param {string} filename - */ + * @function Audio.setReverbOptions + * @param {string} filename + */ Q_INVOKABLE bool startRecording(const QString& filename); /**jsdoc - * @function Audio.stopRecording - */ + * @function Audio.stopRecording + */ Q_INVOKABLE void stopRecording(); /**jsdoc - * @function Audio.getRecording - */ + * @function Audio.getRecording + */ Q_INVOKABLE bool getRecording(); signals: /**jsdoc - * @function Audio.nop - * @returns {Signal} - */ + * @function Audio.nop + * @returns {Signal} + */ void nop(); /**jsdoc - * @function Audio.nop - * @param {bool} isMuted - * @returns {Signal} - */ + * @function Audio.nop + * @param {bool} isMuted + * @returns {Signal} + */ void mutedChanged(bool isMuted); /**jsdoc - * @function Audio.noiseReductionChanged - * @param {bool} isEnabled - * @returns {Signal} - */ + * @function Audio.noiseReductionChanged + * @param {bool} isEnabled + * @returns {Signal} + */ void noiseReductionChanged(bool isEnabled); /**jsdoc - * @function Audio.inputVolumeChanged - * @param {float} volume - * @returns {Signal} - */ + * @function Audio.inputVolumeChanged + * @param {float} volume + * @returns {Signal} + */ void inputVolumeChanged(float volume); /**jsdoc - * @function Audio.inputLevelChanged - * @param {float} level - * @returns {Signal} - */ + * @function Audio.inputLevelChanged + * @param {float} level + * @returns {Signal} + */ void inputLevelChanged(float level); /**jsdoc - * @function Audio.contextChanged - * @param {string} context - * @returns {Signal} - */ + * @function Audio.contextChanged + * @param {string} context + * @returns {Signal} + */ void contextChanged(const QString& context); public slots: /**jsdoc - * @function Audio.onContextChanged - * @returns {Signal} - */ + * @function Audio.onContextChanged + * @returns {Signal} + */ void onContextChanged(); diff --git a/interface/src/scripting/GooglePolyScriptingInterface.h b/interface/src/scripting/GooglePolyScriptingInterface.h index d2fabc0648..55d2236ec1 100644 --- a/interface/src/scripting/GooglePolyScriptingInterface.h +++ b/interface/src/scripting/GooglePolyScriptingInterface.h @@ -16,9 +16,9 @@ #include /**jsdoc -* The GooglePoly API allows you to interact with Google Poly models direct from inside High Fidelity. -* @namespace GooglePoly -*/ + * The GooglePoly API allows you to interact with Google Poly models direct from inside High Fidelity. + * @namespace GooglePoly + */ class GooglePolyScriptingInterface : public QObject, public Dependency { Q_OBJECT @@ -29,81 +29,81 @@ public: public slots: /**jsdoc - * @function GooglePoly.setAPIKey - * @param {string} key - */ + * @function GooglePoly.setAPIKey + * @param {string} key + */ void setAPIKey(const QString& key); /**jsdoc - * @function GooglePoly.getAssetList - * @param {string} keyword - * @param {string} category - * @param {string} format - * @returns {string} - */ + * @function GooglePoly.getAssetList + * @param {string} keyword + * @param {string} category + * @param {string} format + * @returns {string} + */ QString getAssetList(const QString& keyword, const QString& category, const QString& format); /**jsdoc - * @function GooglePoly.getFBX - * @param {string} keyword - * @param {string} category - * @returns {string} - */ + * @function GooglePoly.getFBX + * @param {string} keyword + * @param {string} category + * @returns {string} + */ QString getFBX(const QString& keyword, const QString& category); /**jsdoc - * @function GooglePoly.getOBJ - * @param {string} keyword - * @param {string} category - * @returns {string} - */ + * @function GooglePoly.getOBJ + * @param {string} keyword + * @param {string} category + * @returns {string} + */ QString getOBJ(const QString& keyword, const QString& category); /**jsdoc - * @function GooglePoly.getBlocks - * @param {string} keyword - * @param {string} category - * @returns {string} - */ + * @function GooglePoly.getBlocks + * @param {string} keyword + * @param {string} category + * @returns {string} + */ QString getBlocks(const QString& keyword, const QString& category); /**jsdoc - * @function GooglePoly.getGLTF - * @param {string} keyword - * @param {string} category - * @returns {string} - */ + * @function GooglePoly.getGLTF + * @param {string} keyword + * @param {string} category + * @returns {string} + */ QString getGLTF(const QString& keyword, const QString& category); /**jsdoc - * @function GooglePoly.getGLTF2 - * @param {string} keyword - * @param {string} category - * @returns {string} - */ + * @function GooglePoly.getGLTF2 + * @param {string} keyword + * @param {string} category + * @returns {string} + */ QString getGLTF2(const QString& keyword, const QString& category); /**jsdoc - * @function GooglePoly.getTilt - * @param {string} keyword - * @param {string} category - * @returns {string} - */ + * @function GooglePoly.getTilt + * @param {string} keyword + * @param {string} category + * @returns {string} + */ QString getTilt(const QString& keyword, const QString& category); /**jsdoc - * @function GooglePoly.getModelInfo - * @param {string} input - * @returns {string} - */ + * @function GooglePoly.getModelInfo + * @param {string} input + * @returns {string} + */ QString getModelInfo(const QString& input); diff --git a/interface/src/ui/AvatarInputs.h b/interface/src/ui/AvatarInputs.h index 652cfdcd43..c34542735e 100644 --- a/interface/src/ui/AvatarInputs.h +++ b/interface/src/ui/AvatarInputs.h @@ -24,13 +24,13 @@ class AvatarInputs : public QObject { HIFI_QML_DECL /**jsdoc - * API to help manage your Avatar's input - * @namespace AvatarInputs - * @param {boolean} cameraEnabled - * @param {boolean} cameraMuted - * @param {boolean} isHMD - * @param {boolean} showAudioTools - */ + * API to help manage your Avatar's input + * @namespace AvatarInputs + * @param {boolean} cameraEnabled + * @param {boolean} cameraMuted + * @param {boolean} isHMD + * @param {boolean} showAudioTools + */ AI_PROPERTY(bool, cameraEnabled, false) AI_PROPERTY(bool, cameraMuted, false) @@ -42,10 +42,10 @@ public: static AvatarInputs* getInstance(); /**jsdoc - * @function AvatarInputs.loudnessToAudioLevel - * @param {number} loudness - * @returns {number} - */ + * @function AvatarInputs.loudnessToAudioLevel + * @param {number} loudness + * @returns {number} + */ Q_INVOKABLE float loudnessToAudioLevel(float loudness); AvatarInputs(QObject* parent = nullptr); @@ -55,54 +55,54 @@ public: public slots: /**jsdoc - * @function AvatarInputs.setShowAudioTools - * @param {boolean} showAudioTools - */ + * @function AvatarInputs.setShowAudioTools + * @param {boolean} showAudioTools + */ void setShowAudioTools(bool showAudioTools); signals: /**jsdoc - * @function AvatarInputs.cameraEnabledChanged - * @returns {Signal} - */ + * @function AvatarInputs.cameraEnabledChanged + * @returns {Signal} + */ void cameraEnabledChanged(); /**jsdoc - * @function AvatarInputs.cameraMutedChanged - * @returns {Signal} - */ + * @function AvatarInputs.cameraMutedChanged + * @returns {Signal} + */ void cameraMutedChanged(); /**jsdoc - * @function AvatarInputs.isHMDChanged - * @returns {Signal} - */ + * @function AvatarInputs.isHMDChanged + * @returns {Signal} + */ void isHMDChanged(); /**jsdoc - * @function AvatarInputs.showAudioToolsChanged - * @param {boolean} show - * @returns {Signal} - */ + * @function AvatarInputs.showAudioToolsChanged + * @param {boolean} show + * @returns {Signal} + */ void showAudioToolsChanged(bool show); protected: /**jsdoc - * @function AvatarInputs.resetSensors - */ + * @function AvatarInputs.resetSensors + */ Q_INVOKABLE void resetSensors(); /**jsdoc - * @function AvatarInputs.toggleCameraMute - */ + * @function AvatarInputs.toggleCameraMute + */ Q_INVOKABLE void toggleCameraMute(); diff --git a/libraries/animation/src/AnimationCache.h b/libraries/animation/src/AnimationCache.h index c86086203e..d93c69e6fb 100644 --- a/libraries/animation/src/AnimationCache.h +++ b/libraries/animation/src/AnimationCache.h @@ -21,9 +21,9 @@ #include /**jsdoc -* API to manage Animation Cache resources -* @namespace AnimationCache -*/ + * API to manage Animation Cache resources + * @namespace AnimationCache + */ class Animation; @@ -38,75 +38,75 @@ public: // Copied over from ResourceCache (see ResourceCache.h for reason) /**jsdoc - * @namespace AnimationCache - * @property numTotal {number} total number of total resources - * @property numCached {number} total number of cached resource - * @property sizeTotal {number} size in bytes of all resources - * @property sizeCached {number} size in bytes of all cached resources - */ + * @namespace AnimationCache + * @property numTotal {number} total number of total resources + * @property numCached {number} total number of cached resource + * @property sizeTotal {number} size in bytes of all resources + * @property sizeCached {number} size in bytes of all cached resources + */ /**jsdoc - * Returns the total number of resources - * @function AnimationCache.getNumTotalResources - * @returns {number} - */ + * Returns the total number of resources + * @function AnimationCache.getNumTotalResources + * @returns {number} + */ /**jsdoc - * Returns the total size in bytes of all resources - * @function AnimationCache.getSizeTotalResources - * @returns {number} - */ + * Returns the total size in bytes of all resources + * @function AnimationCache.getSizeTotalResources + * @returns {number} + */ /**jsdoc - * Returns the total number of cached resources - * @function AnimationCache.getNumCachedResources - * @returns {number} - */ + * Returns the total number of cached resources + * @function AnimationCache.getNumCachedResources + * @returns {number} + */ /**jsdoc - * Returns the total size in bytes of cached resources - * @function AnimationCache.getSizeCachedResources - * @returns {number} - */ + * Returns the total size in bytes of cached resources + * @function AnimationCache.getSizeCachedResources + * @returns {number} + */ /**jsdoc - * Returns list of all resource urls - * @function AnimationCache.getResourceList - * @returns {string[]} - */ + * Returns list of all resource urls + * @function AnimationCache.getResourceList + * @returns {string[]} + */ /**jsdoc - * Asynchronously loads a resource from the spedified URL and returns it. - * @param url {string} url of resource to load - * @param fallback {string} fallback URL if load of the desired url fails - * @function AnimationCache.getResource - * @returns {Resource} - */ + * Asynchronously loads a resource from the spedified URL and returns it. + * @param url {string} url of resource to load + * @param fallback {string} fallback URL if load of the desired url fails + * @function AnimationCache.getResource + * @returns {Resource} + */ /**jsdoc - * Prefetches a resource. - * @param url {string} url of resource to load - * @function AnimationCache.prefetch - * @returns {Resource} - */ + * Prefetches a resource. + * @param url {string} url of resource to load + * @function AnimationCache.prefetch + * @returns {Resource} + */ /**jsdoc - * @param {number} deltaSize - * @function AnimationCache.updateTotalSize - * @returns {Resource} - */ + * @param {number} deltaSize + * @function AnimationCache.updateTotalSize + * @returns {Resource} + */ /**jsdoc - * @function AnimationCache.dirty - * @returns {Signal} - */ + * @function AnimationCache.dirty + * @returns {Signal} + */ /**jsdoc - * Returns animation resource for particular animation - * @function AnimationCache.getAnimation - * @param url {string} url to load - * @returns {Resource} animation - */ + * Returns animation resource for particular animation + * @function AnimationCache.getAnimation + * @param url {string} url to load + * @returns {Resource} animation + */ Q_INVOKABLE AnimationPointer getAnimation(const QString& url) { return getAnimation(QUrl(url)); } Q_INVOKABLE AnimationPointer getAnimation(const QUrl& url); diff --git a/libraries/audio-client/src/AudioIOStats.h b/libraries/audio-client/src/AudioIOStats.h index d5c39c7c8b..dd97f1fe9e 100644 --- a/libraries/audio-client/src/AudioIOStats.h +++ b/libraries/audio-client/src/AudioIOStats.h @@ -40,46 +40,46 @@ class AudioStreamStatsInterface : public QObject { Q_OBJECT /**jsdoc - * Audio stats from the Audio Mixer - * @namespace AudioStats.mixerStream - * @param {number} lossRate - * @param {number} lossCount - * @param {number} lossRateWindow - * @param {number} lossCountWindow - * @param {number} framesDesired - * @param {number} framesAvailable - * @param {number} framesAvailableAvg - * @param {number} unplayedMsMax - * @param {number} starveCount - * @param {number} lastStarveDurationCount - * @param {number} dropCount - * @param {number} overflowCount - * @param {number} timegapMsMax - * @param {number} timegapMsAvg - * @param {number} timegapMsMaxWindow - * @param {number} timegapMsAvgWindow - */ + * Audio stats from the Audio Mixer + * @namespace AudioStats.mixerStream + * @param {number} lossRate + * @param {number} lossCount + * @param {number} lossRateWindow + * @param {number} lossCountWindow + * @param {number} framesDesired + * @param {number} framesAvailable + * @param {number} framesAvailableAvg + * @param {number} unplayedMsMax + * @param {number} starveCount + * @param {number} lastStarveDurationCount + * @param {number} dropCount + * @param {number} overflowCount + * @param {number} timegapMsMax + * @param {number} timegapMsAvg + * @param {number} timegapMsMaxWindow + * @param {number} timegapMsAvgWindow + */ /**jsdoc - * Audio stats from the Client Mixer - * @namespace AudioStats.clientMixer - * @param {number} lossRate - * @param {number} lossCount - * @param {number} lossRateWindow - * @param {number} lossCountWindow - * @param {number} framesDesired - * @param {number} framesAvailable - * @param {number} framesAvailableAvg - * @param {number} unplayedMsMax - * @param {number} starveCount - * @param {number} lastStarveDurationCount - * @param {number} dropCount - * @param {number} overflowCount - * @param {number} timegapMsMax - * @param {number} timegapMsAvg - * @param {number} timegapMsMaxWindow - * @param {number} timegapMsAvgWindow - */ + * Audio stats from the Client Mixer + * @namespace AudioStats.clientMixer + * @param {number} lossRate + * @param {number} lossCount + * @param {number} lossRateWindow + * @param {number} lossCountWindow + * @param {number} framesDesired + * @param {number} framesAvailable + * @param {number} framesAvailableAvg + * @param {number} unplayedMsMax + * @param {number} starveCount + * @param {number} lastStarveDurationCount + * @param {number} dropCount + * @param {number} overflowCount + * @param {number} timegapMsMax + * @param {number} timegapMsAvg + * @param {number} timegapMsMaxWindow + * @param {number} timegapMsAvgWindow + */ AUDIO_PROPERTY(float, lossRate) AUDIO_PROPERTY(float, lossCount) @@ -113,17 +113,17 @@ class AudioStatsInterface : public QObject { Q_OBJECT /**jsdoc - * Audio stats from the client - * @namespace AudioStats - * @param {number} pingMs - * @param {number} inputReadMsMax - * @param {number} inputUnplayedMsMax - * @param {number} outputUnplayedMsMax - * @param {number} sentTimegapMsMax - * @param {number} sentTimegapMsAvg - * @param {number} sentTimegapMsMaxWindow - * @param {number} sentTimegapMsAvgWindow - */ + * Audio stats from the client + * @namespace AudioStats + * @param {number} pingMs + * @param {number} inputReadMsMax + * @param {number} inputUnplayedMsMax + * @param {number} outputUnplayedMsMax + * @param {number} sentTimegapMsMax + * @param {number} sentTimegapMsAvg + * @param {number} sentTimegapMsMaxWindow + * @param {number} sentTimegapMsAvgWindow + */ AUDIO_PROPERTY(float, pingMs); @@ -156,23 +156,23 @@ public: signals: /**jsdoc - * @function AudioStats.mixerStreamChanged - * @returns {Signal} - */ + * @function AudioStats.mixerStreamChanged + * @returns {Signal} + */ void mixerStreamChanged(); /**jsdoc - * @function AudioStats.clientStreamChanged - * @returns {Signal} - */ + * @function AudioStats.clientStreamChanged + * @returns {Signal} + */ void clientStreamChanged(); /**jsdoc - * @function AudioStats.injectorStreamsChanged - * @returns {Signal} - */ + * @function AudioStats.injectorStreamsChanged + * @returns {Signal} + */ void injectorStreamsChanged(); diff --git a/libraries/audio/src/SoundCache.h b/libraries/audio/src/SoundCache.h index 0cebf2d7c3..bdb9e106d0 100644 --- a/libraries/audio/src/SoundCache.h +++ b/libraries/audio/src/SoundCache.h @@ -17,9 +17,9 @@ #include "Sound.h" /**jsdoc -* API to manage Sound Cache resources -* @namespace SoundCache -*/ + * API to manage Sound Cache resources + * @namespace SoundCache + */ /// Scriptable interface for sound loading. @@ -31,82 +31,81 @@ public: // Copied over from ResourceCache (see ResourceCache.h for reason) /**jsdoc - * @namespace SoundCache - * @property numTotal {number} total number of total resources - * @property numCached {number} total number of cached resource - * @property sizeTotal {number} size in bytes of all resources - * @property sizeCached {number} size in bytes of all cached resources - */ + * @namespace SoundCache + * @property numTotal {number} total number of total resources + * @property numCached {number} total number of cached resource + * @property sizeTotal {number} size in bytes of all resources + * @property sizeCached {number} size in bytes of all cached resources + */ /**jsdoc - * Returns the total number of resources - * @function SoundCache.getNumTotalResources - * @returns {number} - */ + * Returns the total number of resources + * @function SoundCache.getNumTotalResources + * @returns {number} + */ /**jsdoc - * Returns the total size in bytes of all resources - * @function SoundCache.getSizeTotalResources - * @returns {number} - */ + * Returns the total size in bytes of all resources + * @function SoundCache.getSizeTotalResources + * @returns {number} + */ /**jsdoc - * Returns the total number of cached resources - * @function SoundCache.getNumCachedResources - * @returns {number} - */ + * Returns the total number of cached resources + * @function SoundCache.getNumCachedResources + * @returns {number} + */ /**jsdoc - * Returns the total size in bytes of cached resources - * @function SoundCache.getSizeCachedResources - * @returns {number} - */ + * Returns the total size in bytes of cached resources + * @function SoundCache.getSizeCachedResources + * @returns {number} + */ /**jsdoc - * Returns list of all resource urls - * @function SoundCache.getResourceList - * @returns {string[]} - */ + * Returns list of all resource urls + * @function SoundCache.getResourceList + * @returns {string[]} + */ /**jsdoc - * Returns animation resource for particular animation - * @function SoundCache.getAnimation - * @param url {string} url to load - * @returns {Resource} animation - */ + * Returns animation resource for particular animation + * @function SoundCache.getAnimation + * @param url {string} url to load + * @returns {Resource} animation + */ /**jsdoc - * Asynchronously loads a resource from the spedified URL and returns it. - * @param url {string} url of resource to load - * @param fallback {string} fallback URL if load of the desired url fails - * @function SoundCache.getResource - * @returns {Resource} - */ + * Asynchronously loads a resource from the spedified URL and returns it. + * @param url {string} url of resource to load + * @param fallback {string} fallback URL if load of the desired url fails + * @function SoundCache.getResource + * @returns {Resource} + */ /**jsdoc - * Prefetches a resource. - * @param url {string} url of resource to load - * @function SoundCache.prefetch - * @returns {Resource} - */ + * Prefetches a resource. + * @param url {string} url of resource to load + * @function SoundCache.prefetch + * @returns {Resource} + */ /**jsdoc - * To Be Completed - * @param {number} deltaSize - * @function SoundCache.updateTotalSize - * @returns {Resource} - */ + * @param {number} deltaSize + * @function SoundCache.updateTotalSize + * @returns {Resource} + */ /**jsdoc - * @function SoundCache.dirty - * @returns {Signal} - */ + * @function SoundCache.dirty + * @returns {Signal} + */ /**jsdoc - * @function SoundCache.getSound - * @param {string} url - * @returns {} - */ + * @function SoundCache.getSound + * @param {string} url + * @returns {} + */ Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url); protected: diff --git a/libraries/avatars/src/AvatarHashMap.h b/libraries/avatars/src/AvatarHashMap.h index 799bce49f7..77e0b1e5c7 100644 --- a/libraries/avatars/src/AvatarHashMap.h +++ b/libraries/avatars/src/AvatarHashMap.h @@ -31,9 +31,9 @@ #include "AvatarData.h" /**jsdoc -* The AvatarHashMap API deals with functionality related to Avatar information and connectivity -* @namespace AvatarHashMap -*/ + * The AvatarHashMap API deals with functionality related to Avatar information and connectivity + * @namespace AvatarHashMap + */ // JSDoc 3.5.5 doesn't augment @property definitions. // These functions are being copied into Avatar classes which inherit the AvatarHashMap @@ -51,25 +51,25 @@ public: // Currently, your own avatar will be included as the null avatar id. /**jsdoc - * @function AvatarHashMap.getAvatarIdentifiers - */ + * @function AvatarHashMap.getAvatarIdentifiers + */ Q_INVOKABLE QVector getAvatarIdentifiers(); /**jsdoc - * @function AvatarHashMap.getAvatarsInRange - * @param {Vec3} position - * @param {float} rangeMeters - * @returns {string[]} - */ + * @function AvatarHashMap.getAvatarsInRange + * @param {Vec3} position + * @param {float} rangeMeters + * @returns {string[]} + */ Q_INVOKABLE QVector getAvatarsInRange(const glm::vec3& position, float rangeMeters) const; /**jsdoc - * @function AvatarHashMap.getAvatar - * @param {string} avatarID - * @returns {ScriptAvatarData} - */ + * @function AvatarHashMap.getAvatar + * @param {string} avatarID + * @returns {ScriptAvatarData} + */ // Null/Default-constructed QUuids will return MyAvatar Q_INVOKABLE virtual ScriptAvatarData* getAvatar(QUuid avatarID) { return new ScriptAvatarData(getAvatarBySessionID(avatarID)); } @@ -80,72 +80,72 @@ public: signals: /**jsdoc - * @function AvatarHashMap.avatarAddedEvent - * @param {string} sessionUUID - * @returns {Signal} - */ + * @function AvatarHashMap.avatarAddedEvent + * @param {string} sessionUUID + * @returns {Signal} + */ void avatarAddedEvent(const QUuid& sessionUUID); /**jsdoc - * @function AvatarHashMap.avatarRemovedEvent - * @param {string} sessionUUID - * @returns {Signal} - */ + * @function AvatarHashMap.avatarRemovedEvent + * @param {string} sessionUUID + * @returns {Signal} + */ void avatarRemovedEvent(const QUuid& sessionUUID); /**jsdoc - * @function AvatarHashMap.avatarSessionChangedEvent - * @param {string} sessionUUID - * @param {string} oldUUID - * @returns {Signal} - */ + * @function AvatarHashMap.avatarSessionChangedEvent + * @param {string} sessionUUID + * @param {string} oldUUID + * @returns {Signal} + */ void avatarSessionChangedEvent(const QUuid& sessionUUID,const QUuid& oldUUID); public slots: /**jsdoc - * @function AvatarHashMap.isAvatarInRange - * @param {string} position - * @param {string} range - * @returns {boolean} - */ + * @function AvatarHashMap.isAvatarInRange + * @param {string} position + * @param {string} range + * @returns {boolean} + */ bool isAvatarInRange(const glm::vec3 & position, const float range); protected slots: /**jsdoc - * @function AvatarHashMap.sessionUUIDChanged - * @param {string} sessionUUID - * @param {string} oldUUID - */ + * @function AvatarHashMap.sessionUUIDChanged + * @param {string} sessionUUID + * @param {string} oldUUID + */ void sessionUUIDChanged(const QUuid& sessionUUID, const QUuid& oldUUID); /**jsdoc - * @function AvatarHashMap.processAvatarDataPacket - * @param {} message - * @param {} sendingNode - */ + * @function AvatarHashMap.processAvatarDataPacket + * @param {} message + * @param {} sendingNode + */ void processAvatarDataPacket(QSharedPointer message, SharedNodePointer sendingNode); /**jsdoc - * @function AvatarHashMap.processAvatarIdentityPacket - * @param {} message - * @param {} sendingNode - */ + * @function AvatarHashMap.processAvatarIdentityPacket + * @param {} message + * @param {} sendingNode + */ void processAvatarIdentityPacket(QSharedPointer message, SharedNodePointer sendingNode); /**jsdoc - * @function AvatarHashMap.processKillAvatar - * @param {} message - * @param {} sendingNode - */ + * @function AvatarHashMap.processKillAvatar + * @param {} message + * @param {} sendingNode + */ void processKillAvatar(QSharedPointer message, SharedNodePointer sendingNode); diff --git a/libraries/model-networking/src/model-networking/TextureCache.h b/libraries/model-networking/src/model-networking/TextureCache.h index ff8adceb42..174a25fee2 100644 --- a/libraries/model-networking/src/model-networking/TextureCache.h +++ b/libraries/model-networking/src/model-networking/TextureCache.h @@ -138,9 +138,9 @@ using NetworkTexturePointer = QSharedPointer; Q_DECLARE_METATYPE(QWeakPointer) /**jsdoc -* API to manage Texture Cache resources -* @namespace TextureCache -*/ + * API to manage Texture Cache resources + * @namespace TextureCache + */ /// Stores cached textures, including render-to-texture targets. class TextureCache : public ResourceCache, public Dependency { @@ -151,75 +151,75 @@ public: // Copied over from ResourceCache (see ResourceCache.h for reason) /**jsdoc - * @namespace TextureCache - * @property numTotal {number} total number of total resources - * @property numCached {number} total number of cached resource - * @property sizeTotal {number} size in bytes of all resources - * @property sizeCached {number} size in bytes of all cached resources - */ + * @namespace TextureCache + * @property numTotal {number} total number of total resources + * @property numCached {number} total number of cached resource + * @property sizeTotal {number} size in bytes of all resources + * @property sizeCached {number} size in bytes of all cached resources + */ /**jsdoc - * Returns the total number of resources - * @function TextureCache.getNumTotalResources - * @returns {number} - */ + * Returns the total number of resources + * @function TextureCache.getNumTotalResources + * @returns {number} + */ /**jsdoc - * Returns the total size in bytes of all resources - * @function TextureCache.getSizeTotalResources - * @returns {number} - */ + * Returns the total size in bytes of all resources + * @function TextureCache.getSizeTotalResources + * @returns {number} + */ /**jsdoc - * Returns the total number of cached resources - * @function TextureCache.getNumCachedResources - * @returns {number} - */ + * Returns the total number of cached resources + * @function TextureCache.getNumCachedResources + * @returns {number} + */ /**jsdoc - * Returns the total size in bytes of cached resources - * @function TextureCache.getSizeCachedResources - * @returns {number} - */ + * Returns the total size in bytes of cached resources + * @function TextureCache.getSizeCachedResources + * @returns {number} + */ /**jsdoc - * Returns list of all resource urls - * @function TextureCache.getResourceList - * @returns {string[]} - */ + * Returns list of all resource urls + * @function TextureCache.getResourceList + * @returns {string[]} + */ /**jsdoc - * Returns animation resource for particular animation - * @function TextureCache.getAnimation - * @param url {string} url to load - * @returns {Resource} animation - */ + * Returns animation resource for particular animation + * @function TextureCache.getAnimation + * @param url {string} url to load + * @returns {Resource} animation + */ /**jsdoc - * Asynchronously loads a resource from the spedified URL and returns it. - * @param url {string} url of resource to load - * @param fallback {string} fallback URL if load of the desired url fails - * @function TextureCache.getResource - * @returns {Resource} - */ + * Asynchronously loads a resource from the spedified URL and returns it. + * @param url {string} url of resource to load + * @param fallback {string} fallback URL if load of the desired url fails + * @function TextureCache.getResource + * @returns {Resource} + */ /**jsdoc - * Prefetches a resource. - * @param url {string} url of resource to load - * @function TextureCache.prefetch - * @returns {Resource} - */ + * Prefetches a resource. + * @param url {string} url of resource to load + * @function TextureCache.prefetch + * @returns {Resource} + */ /**jsdoc - * @param {number} deltaSize - * @function TextureCache.updateTotalSize - * @returns {Resource} - */ + * @param {number} deltaSize + * @function TextureCache.updateTotalSize + * @returns {Resource} + */ /**jsdoc - * @function TextureCache.dirty - * @returns {Signal} - */ + * @function TextureCache.dirty + * @returns {Signal} + */ /// Returns the ID of the permutation/normal texture used for Perlin noise shader programs. This texture /// has two lines: the first, a set of random numbers in [0, 255] to be used as permutation offsets, and @@ -259,9 +259,9 @@ public: signals: /**jsdoc - * @function TextureCache.spectatorCameraFramebufferReset - * @returns {Signal} - */ + * @function TextureCache.spectatorCameraFramebufferReset + * @returns {Signal} + */ void spectatorCameraFramebufferReset(); protected: diff --git a/libraries/networking/src/ResourceCache.h b/libraries/networking/src/ResourceCache.h index 2b53799ea2..ddea7c51cf 100644 --- a/libraries/networking/src/ResourceCache.h +++ b/libraries/networking/src/ResourceCache.h @@ -88,10 +88,10 @@ class ScriptableResource : public QObject { /**jsdoc - * @constructor Resource - * @property url {string} url of this resource - * @property state {Resource.State} current loading state - */ + * @constructor Resource + * @property url {string} url of this resource + * @property state {Resource.State} current loading state + */ Q_OBJECT Q_PROPERTY(QUrl url READ getURL) @@ -139,20 +139,20 @@ public: signals: /**jsdoc - * Signaled when download progress for this resource has changed - * @function Resource#progressChanged - * @param bytesReceived {int} bytes downloaded so far - * @param bytesTotal {int} total number of bytes in the resource - * @returns {Signal} - */ + * Signaled when download progress for this resource has changed + * @function Resource#progressChanged + * @param bytesReceived {int} bytes downloaded so far + * @param bytesTotal {int} total number of bytes in the resource + * @returns {Signal} + */ void progressChanged(uint64_t bytesReceived, uint64_t bytesTotal); /**jsdoc - * Signaled when resource loading state has changed - * @function Resource#stateChanged - * @param bytesReceived {Resource.State} new state - * @returns {Signal} - */ + * Signaled when resource loading state has changed + * @function Resource#stateChanged + * @param bytesReceived {Resource.State} new state + * @returns {Signal} + */ void stateChanged(int state); protected: @@ -188,12 +188,12 @@ class ResourceCache : public QObject { // JSDoc 3.5.5 doesn't augment @property definitions. // These functions are being copied into the different exposed cache classes /**jsdoc - * @namespace ResourceCache - * @property numTotal {number} total number of total resources - * @property numCached {number} total number of cached resource - * @property sizeTotal {number} size in bytes of all resources - * @property sizeCached {number} size in bytes of all cached resources - */ + * @namespace ResourceCache + * @property numTotal {number} total number of total resources + * @property numCached {number} total number of cached resource + * @property sizeTotal {number} size in bytes of all resources + * @property sizeCached {number} size in bytes of all cached resources + */ Q_PROPERTY(size_t numTotal READ getNumTotalResources NOTIFY dirty) Q_PROPERTY(size_t numCached READ getNumCachedResources NOTIFY dirty) Q_PROPERTY(size_t sizeTotal READ getSizeTotalResources NOTIFY dirty) @@ -201,38 +201,38 @@ class ResourceCache : public QObject { public: /**jsdoc - * Returns the total number of resources - * @function ResourceCache.getNumTotalResources - * @return {number} - */ + * Returns the total number of resources + * @function ResourceCache.getNumTotalResources + * @return {number} + */ size_t getNumTotalResources() const { return _numTotalResources; } /**jsdoc - * Returns the total size in bytes of all resources - * @function ResourceCache.getSizeTotalResources - * @return {number} - */ + * Returns the total size in bytes of all resources + * @function ResourceCache.getSizeTotalResources + * @return {number} + */ size_t getSizeTotalResources() const { return _totalResourcesSize; } /**jsdoc - * Returns the total number of cached resources - * @function ResourceCache.getNumCachedResources - * @return {number} - */ + * Returns the total number of cached resources + * @function ResourceCache.getNumCachedResources + * @return {number} + */ size_t getNumCachedResources() const { return _numUnusedResources; } /**jsdoc - * Returns the total size in bytes of cached resources - * @function ResourceCache.getSizeCachedResources - * @return {number} - */ + * Returns the total size in bytes of cached resources + * @function ResourceCache.getSizeCachedResources + * @return {number} + */ size_t getSizeCachedResources() const { return _unusedResourcesSize; } /**jsdoc - * Returns list of all resource urls - * @function ResourceCache.getResourceList - * @return {string[]} - */ + * Returns list of all resource urls + * @function ResourceCache.getResourceList + * @return {string[]} + */ Q_INVOKABLE QVariantList getResourceList(); static void setRequestLimit(int limit); @@ -273,12 +273,12 @@ protected slots: /// \param fallback a fallback URL to load if the desired one is unavailable /// \param extra extra data to pass to the creator, if appropriate /**jsdoc - * Asynchronously loads a resource from the spedified URL and returns it. - * @param url {string} url of resource to load - * @param fallback {string} fallback URL if load of the desired url fails - * @function ResourceCache.getResource - * @return {Resource} - */ + * Asynchronously loads a resource from the spedified URL and returns it. + * @param url {string} url of resource to load + * @param fallback {string} fallback URL if load of the desired url fails + * @function ResourceCache.getResource + * @return {Resource} + */ QSharedPointer getResource(const QUrl& url, const QUrl& fallback = QUrl(), void* extra = NULL); @@ -291,11 +291,11 @@ protected: // which should be a QScriptEngine with ScriptableResource registered, so that // the QScriptEngine will delete the pointer when it is garbage collected. /**jsdoc - * Prefetches a resource. - * @param url {string} url of resource to load - * @function ResourceCache.prefetch - * @return {Resource} - */ + * Prefetches a resource. + * @param url {string} url of resource to load + * @function ResourceCache.prefetch + * @return {Resource} + */ Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url) { return prefetch(url, nullptr); } /// Creates a new resource. diff --git a/libraries/script-engine/src/AssetScriptingInterface.h b/libraries/script-engine/src/AssetScriptingInterface.h index 8b94413dfc..60994f988e 100644 --- a/libraries/script-engine/src/AssetScriptingInterface.h +++ b/libraries/script-engine/src/AssetScriptingInterface.h @@ -35,82 +35,82 @@ public: AssetScriptingInterface(QObject* parent = nullptr); /**jsdoc - * Upload content to the connected domain's asset server. - * @function Assets.uploadData - * @static - * @param data {string} content to upload - * @param callback {Assets~uploadDataCallback} called when upload is complete - */ + * Upload content to the connected domain's asset server. + * @function Assets.uploadData + * @static + * @param data {string} content to upload + * @param callback {Assets~uploadDataCallback} called when upload is complete + */ /**jsdoc - * Called when uploadData is complete - * @callback Assets~uploadDataCallback - * @param {string} url - * @param {string} hash - */ + * Called when uploadData is complete + * @callback Assets~uploadDataCallback + * @param {string} url + * @param {string} hash + */ Q_INVOKABLE void uploadData(QString data, QScriptValue callback); /**jsdoc - * Download data from the connected domain's asset server. - * @function Assets.downloadData - * @param url {string} URL of asset to download, must be ATP scheme URL. - * @param callback {Assets~downloadDataCallback} - */ + * Download data from the connected domain's asset server. + * @function Assets.downloadData + * @param url {string} URL of asset to download, must be ATP scheme URL. + * @param callback {Assets~downloadDataCallback} + */ /**jsdoc - * Called when downloadData is complete - * @callback Assets~downloadDataCallback - * @param data {string} content that was downloaded - */ + * Called when downloadData is complete + * @callback Assets~downloadDataCallback + * @param data {string} content that was downloaded + */ Q_INVOKABLE void downloadData(QString url, QScriptValue downloadComplete); /**jsdoc - * Sets up a path to hash mapping within the connected domain's asset server - * @function Assets.setMapping - * @param path {string} - * @param hash {string} - * @param callback {Assets~setMappingCallback} - */ + * Sets up a path to hash mapping within the connected domain's asset server + * @function Assets.setMapping + * @param path {string} + * @param hash {string} + * @param callback {Assets~setMappingCallback} + */ /**jsdoc - * Called when setMapping is complete - * @callback Assets~setMappingCallback - * @param {string} error - */ + * Called when setMapping is complete + * @callback Assets~setMappingCallback + * @param {string} error + */ Q_INVOKABLE void setMapping(QString path, QString hash, QScriptValue callback); /**jsdoc - * Look up a path to hash mapping within the connected domain's asset server - * @function Assets.getMapping - * @param path {string} - * @param callback {Assets~getMappingCallback} - */ + * Look up a path to hash mapping within the connected domain's asset server + * @function Assets.getMapping + * @param path {string} + * @param callback {Assets~getMappingCallback} + */ /**jsdoc - * Called when getMapping is complete. - * @callback Assets~getMappingCallback - * @param assetID {string} hash value if found, else an empty string - * @param error {string} error description if the path could not be resolved; otherwise a null value. - */ + * Called when getMapping is complete. + * @callback Assets~getMappingCallback + * @param assetID {string} hash value if found, else an empty string + * @param error {string} error description if the path could not be resolved; otherwise a null value. + */ /**jsdoc - * Called when getMapping is complete. - * @callback Assets~getMappingCallback - * @param assetID {string} hash value if found, else an empty string - * @param error {string} error description if the path could not be resolved; otherwise a null value. - */ + * Called when getMapping is complete. + * @callback Assets~getMappingCallback + * @param assetID {string} hash value if found, else an empty string + * @param error {string} error description if the path could not be resolved; otherwise a null value. + */ Q_INVOKABLE void getMapping(QString path, QScriptValue callback); /**jsdoc - * @function Assets.setBakingEnabled - * @param path {string} - * @param enabled {boolean} - * @param callback {} - */ + * @function Assets.setBakingEnabled + * @param path {string} + * @param enabled {boolean} + * @param callback {} + */ Q_INVOKABLE void setBakingEnabled(QString path, bool enabled, QScriptValue callback); @@ -119,172 +119,172 @@ public: #endif /**jsdoc - * Request Asset data from the ATP Server - * @function Assets.getAsset - * @param {URL|Assets.GetOptions} options An atp: style URL, hash, or relative mapped path; or an {@link Assets.GetOptions} object with request parameters - * @param {Assets~getAssetCallback} scope[callback] A scope callback function to receive (error, results) values - */ + * Request Asset data from the ATP Server + * @function Assets.getAsset + * @param {URL|Assets.GetOptions} options An atp: style URL, hash, or relative mapped path; or an {@link Assets.GetOptions} object with request parameters + * @param {Assets~getAssetCallback} scope[callback] A scope callback function to receive (error, results) values + */ /**jsdoc - * A set of properties that can be passed to {@link Assets.getAsset}. - * @typedef {Object} Assets.GetOptions - * @property {URL} [url] an "atp:" style URL, hash, or relative mapped path to fetch - * @property {string} [responseType=text] the desired reponse type (text | arraybuffer | json) - * @property {boolean} [decompress=false] whether to attempt gunzip decompression on the fetched data - * See: {@link Assets.putAsset} and its .compress=true option - */ + * A set of properties that can be passed to {@link Assets.getAsset}. + * @typedef {Object} Assets.GetOptions + * @property {URL} [url] an "atp:" style URL, hash, or relative mapped path to fetch + * @property {string} [responseType=text] the desired reponse type (text | arraybuffer | json) + * @property {boolean} [decompress=false] whether to attempt gunzip decompression on the fetched data + * See: {@link Assets.putAsset} and its .compress=true option + */ /**jsdoc - * Called when Assets.getAsset is complete. - * @callback Assets~getAssetCallback - * @param {string} error - contains error message or null value if no error occured fetching the asset - * @param {Asset~getAssetResult} result - result object containing, on success containing asset metadata and contents - */ + * Called when Assets.getAsset is complete. + * @callback Assets~getAssetCallback + * @param {string} error - contains error message or null value if no error occured fetching the asset + * @param {Asset~getAssetResult} result - result object containing, on success containing asset metadata and contents + */ /**jsdoc - * Result value returned by {@link Assets.getAsset}. - * @typedef {Object} Assets~getAssetResult - * @property {url} [url] the resolved "atp:" style URL for the fetched asset - * @property {string} [hash] the resolved hash for the fetched asset - * @property {string|ArrayBuffer|Object} [response] response data (possibly converted per .responseType value) - * @property {string} [responseType] response type (text | arraybuffer | json) - * @property {string} [contentType] detected asset mime-type (autodetected) - * @property {number} [byteLength] response data size in bytes - * @property {number} [decompressed] flag indicating whether data was decompressed - */ + * Result value returned by {@link Assets.getAsset}. + * @typedef {Object} Assets~getAssetResult + * @property {url} [url] the resolved "atp:" style URL for the fetched asset + * @property {string} [hash] the resolved hash for the fetched asset + * @property {string|ArrayBuffer|Object} [response] response data (possibly converted per .responseType value) + * @property {string} [responseType] response type (text | arraybuffer | json) + * @property {string} [contentType] detected asset mime-type (autodetected) + * @property {number} [byteLength] response data size in bytes + * @property {number} [decompressed] flag indicating whether data was decompressed + */ Q_INVOKABLE void getAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * Upload Asset data to the ATP Server - * @function Assets.putAsset - * @param {Assets.PutOptions} options A PutOptions object with upload parameters - * @param {Assets~putAssetCallback} scope[callback] A scoped callback function invoked with (error, results) - */ + * Upload Asset data to the ATP Server + * @function Assets.putAsset + * @param {Assets.PutOptions} options A PutOptions object with upload parameters + * @param {Assets~putAssetCallback} scope[callback] A scoped callback function invoked with (error, results) + */ /**jsdoc - * A set of properties that can be passed to {@link Assets.putAsset}. - * @typedef {Object} Assets.PutOptions - * @property {ArrayBuffer|string} [data] byte buffer or string value representing the new asset's content - * @property {string} [path=null] ATP path mapping to automatically create (upon successful upload to hash) - * @property {boolean} [compress=false] whether to gzip compress data before uploading - */ + * A set of properties that can be passed to {@link Assets.putAsset}. + * @typedef {Object} Assets.PutOptions + * @property {ArrayBuffer|string} [data] byte buffer or string value representing the new asset's content + * @property {string} [path=null] ATP path mapping to automatically create (upon successful upload to hash) + * @property {boolean} [compress=false] whether to gzip compress data before uploading + */ /**jsdoc - * Called when Assets.putAsset is complete. - * @callback Assets~puttAssetCallback - * @param {string} error - contains error message (or null value if no error occured while uploading/mapping the new asset) - * @param {Asset~putAssetResult} result - result object containing error or result status of asset upload - */ + * Called when Assets.putAsset is complete. + * @callback Assets~puttAssetCallback + * @param {string} error - contains error message (or null value if no error occured while uploading/mapping the new asset) + * @param {Asset~putAssetResult} result - result object containing error or result status of asset upload + */ - /**jsdoc - * Result value returned by {@link Assets.putAsset}. - * @typedef {Object} Assets~putAssetResult - * @property {url} [url] the resolved "atp:" style URL for the uploaded asset (based on .path if specified, otherwise on the resulting ATP hash) - * @property {string} [path] the uploaded asset's resulting ATP path (or undefined if no path mapping was assigned) - * @property {string} [hash] the uploaded asset's resulting ATP hash - * @property {boolean} [compressed] flag indicating whether the data was compressed before upload - * @property {number} [byteLength] flag indicating final byte size of the data uploaded to the ATP server - */ + /**jsdoc + * Result value returned by {@link Assets.putAsset}. + * @typedef {Object} Assets~putAssetResult + * @property {url} [url] the resolved "atp:" style URL for the uploaded asset (based on .path if specified, otherwise on the resulting ATP hash) + * @property {string} [path] the uploaded asset's resulting ATP path (or undefined if no path mapping was assigned) + * @property {string} [hash] the uploaded asset's resulting ATP hash + * @property {boolean} [compressed] flag indicating whether the data was compressed before upload + * @property {number} [byteLength] flag indicating final byte size of the data uploaded to the ATP server + */ Q_INVOKABLE void putAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * @function Assets.deleteAsset - * @property {} options - * @property {} scope - * @property {} callback - */ + * @function Assets.deleteAsset + * @property {} options + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void deleteAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * @function Assets.resolveAsset - * @property {} options - * @property {} scope - * @property {} callback - */ + * @function Assets.resolveAsset + * @property {} options + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void resolveAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * @function Assets.decompressData - * @property {} options - * @property {} scope - * @property {} callback - */ + * @function Assets.decompressData + * @property {} options + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void decompressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * @function Assets.compressData - * @property {} options - * @property {} scope - * @property {} callback - */ + * @function Assets.compressData + * @property {} options + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void compressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * @function Assets.initializeCache - * @returns {boolean} - */ + * @function Assets.initializeCache + * @returns {boolean} + */ Q_INVOKABLE bool initializeCache() { return Parent::initializeCache(); } /**jsdoc - * @function Assets.canWriteCacheValue - * @property {string} url - * @returns {boolean} - */ + * @function Assets.canWriteCacheValue + * @property {string} url + * @returns {boolean} + */ Q_INVOKABLE bool canWriteCacheValue(const QUrl& url); /**jsdoc - * @function Assets.getCacheStatus - * @property {} scope - * @property {} callback - */ + * @function Assets.getCacheStatus + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void getCacheStatus(QScriptValue scope, QScriptValue callback = QScriptValue()) { jsPromiseReady(Parent::getCacheStatus(), scope, callback); } /**jsdoc - * @function Assets.queryCacheMeta - * @property {} options - * @property {} scope - * @property {} callback - */ + * @function Assets.queryCacheMeta + * @property {} options + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void queryCacheMeta(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * @function Assets.loadFromCache - * @property {} options - * @property {} scope - * @property {} callback - */ + * @function Assets.loadFromCache + * @property {} options + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void loadFromCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * @function Assets.saveToCache - * @property {} options - * @property {} scope - * @property {} callback - */ + * @function Assets.saveToCache + * @property {} options + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void saveToCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); /**jsdoc - * @function Assets.saveToCache - * @property {} url - * @property {} data - * @property {} metadata - * @property {} scope - * @property {} callback - */ + * @function Assets.saveToCache + * @property {} url + * @property {} data + * @property {} metadata + * @property {} scope + * @property {} callback + */ Q_INVOKABLE void saveToCache(const QUrl& url, const QByteArray& data, const QVariantMap& metadata, QScriptValue scope, QScriptValue callback = QScriptValue()); diff --git a/libraries/trackers/src/trackers/FaceTracker.h b/libraries/trackers/src/trackers/FaceTracker.h index bc54878e69..4224bb6633 100644 --- a/libraries/trackers/src/trackers/FaceTracker.h +++ b/libraries/trackers/src/trackers/FaceTracker.h @@ -61,31 +61,31 @@ public: signals: /**jsdoc - * @function FaceTracker.muteToggled - * @returns {Signal} - */ + * @function FaceTracker.muteToggled + * @returns {Signal} + */ void muteToggled(); public slots: /**jsdoc - * @function FaceTracker.setEnabled - * @param {boolean} enabled - */ + * @function FaceTracker.setEnabled + * @param {boolean} enabled + */ virtual void setEnabled(bool enabled) = 0; /**jsdoc - * @function FaceTracker.toggleMute - */ + * @function FaceTracker.toggleMute + */ void toggleMute(); /**jsdoc - * @function FaceTracker.getMuted - * @returns {boolean} - */ + * @function FaceTracker.getMuted + * @returns {boolean} + */ bool getMuted() { return _isMuted; }