Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-04-08 07:02:25 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix tabs

Browse source
This commit is contained in:
milad nazeri 2018-04-23 21:47:53 -07:00
parent e25c871a52
commit 1121fe8da0
17 changed files with 297 additions and 298 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
interface/src/Bookmarks.h
View file

@ -48,10 +48,10 @@ protected:
bool _isMenuSorted;
protected slots:
/**jsdoc
* Delete
* @function AvatarBookmarks.deleteBookmark
*/
/**jsdoc
* Delete
* @function AvatarBookmarks.deleteBookmark
*/
void deleteBookmark();
private:

12
interface/src/LODManager.h
View file

@ -44,7 +44,7 @@ class LODManager : public QObject, public Dependency {
SINGLETON_DEPENDENCY
public:
/**jsdoc
* @function LODManager.setAutomaticLODAdjust
* @param {boolean} value
@ -54,14 +54,14 @@ public:
/**jsdoc
* @function LODManager.getAutomaticLODAdjust
* @returns {boolean}
* @returns {boolean}
*/
Q_INVOKABLE bool getAutomaticLODAdjust() const { return _automaticLODAdjust; }
/**jsdoc
* @function LODManager.setDesktopLODDecreaseFPS
* @param {float} value
* @param {float} value
*/
Q_INVOKABLE void setDesktopLODDecreaseFPS(float value);
@ -125,7 +125,7 @@ public:
/**jsdoc
* @function LODManager.setBoundaryLevelAdjust
* @param {number} boundaryLevelAdjust
* @param {number} boundaryLevelAdjust
*/
Q_INVOKABLE void setBoundaryLevelAdjust(int boundaryLevelAdjust);
@ -152,8 +152,8 @@ public:
Q_INVOKABLE float getLODIncreaseFPS() const;
/**jsdoc
* @namespace LODManager
* @property presentTime {number}
* @namespace LODManager
* @property presentTime {number}
* @property engineRunTime {number}
* @property gpuTime {number}
* @property avgRenderTime {number}

30
interface/src/audio/AudioScope.h
View file

@ -25,10 +25,10 @@ class AudioScope : public QObject, public Dependency {
Q_OBJECT
SINGLETON_DEPENDENCY
/**jsdoc
* The AudioScope API helps control the Audio Scope features in Interface
* @namespace AudioScope
* @property {int} scopeInput
/**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
@ -52,15 +52,15 @@ public:
public slots:
/**jsdoc
* @function AudioScope.toggle
*/
/**jsdoc
* @function AudioScope.toggle
*/
void toggle() { setVisible(!_isEnabled); }
/**jsdoc
* @function AudioScope.setVisible
* @param {boolean} visible
* @param {boolean} visible
*/
void setVisible(bool visible);
@ -68,7 +68,7 @@ public slots:
/**jsdoc
* @function AudioScope.getVisible
* @param {boolean} visible
* @returns {boolean}
* @returns {boolean}
*/
bool getVisible() const { return _isEnabled; }
@ -88,7 +88,7 @@ public slots:
/**jsdoc
* @function AudioScope.getPause
* @returns {boolean}
* @returns {boolean}
*/
bool getPause() { return _isPaused; }
@ -101,14 +101,14 @@ public slots:
/**jsdoc
* @function AudioScope.getAutoTrigger
* @returns {boolean}
* @returns {boolean}
*/
bool getAutoTrigger() { return _autoTrigger; }
/**jsdoc
* @function AudioScope.setAutoTrigger
* @param {boolean} autoTrigger
* @param {boolean} autoTrigger
*/
void setAutoTrigger(bool autoTrigger) { _isTriggered = false; _autoTrigger = autoTrigger; }
@ -169,7 +169,7 @@ public slots:
/**jsdoc
* @function AudioScope.getScopeInput
* @returns {number}
* @returns {number}
*/
QVector<int> getScopeInput() { return _scopeInputData; };
@ -227,7 +227,7 @@ signals:
/**jsdoc
* @function AudioScope.pauseChanged
* @returns {Signal}
* @returns {Signal}
*/
void pauseChanged();

20
interface/src/avatar/AvatarManager.h
View file

@ -117,10 +117,10 @@ public:
std::shared_ptr<MyAvatar> getMyAvatar() { return _myAvatar; }
glm::vec3 getMyAvatarPosition() const { return _myAvatar->getWorldPosition(); }
/**jsdoc
/**jsdoc
* @function AvatarManager.getAvatar
* @param {string} avatarID
* @returns {}
* @param {string} avatarID
* @returns {}
*/
// Null/Default-constructed QUuids will return MyAvatar
@ -207,9 +207,9 @@ public:
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);
@ -218,10 +218,10 @@ public:
public slots:
/**jsdoc
* @function AvatarManager.updateAvatarRenderStatus
* @param {boolean} shouldRenderAvatars
*/
/**jsdoc
* @function AvatarManager.updateAvatarRenderStatus
* @param {boolean} shouldRenderAvatars
*/
void updateAvatarRenderStatus(bool shouldRenderAvatars);

4
interface/src/devices/DdeFaceTracker.h
View file

@ -63,9 +63,9 @@ public:
public slots:
/**jsdoc
/**jsdoc
* @function FaceTracker.setEnabled
* @param {boolean} enabled
* @param {boolean} enabled
*/
void setEnabled(bool enabled) override;

8
interface/src/scripting/AccountServicesScriptingInterface.h
View file

@ -59,10 +59,10 @@ public:
public slots:
/**jsdoc
* @function AccountServices.getDownloadInfo
* @returns {DownloadInfoResult}
*/
/**jsdoc
* @function AccountServices.getDownloadInfo
* @returns {DownloadInfoResult}
*/
DownloadInfoResult getDownloadInfo();

11
interface/src/scripting/Audio.h
View file

@ -86,7 +86,7 @@ public:
Q_INVOKABLE void setReverb(bool enable);
/**jsdoc
/**jsdoc
* @function Audio.setReverbOptions
* @param {} options
*/
@ -94,21 +94,20 @@ public:
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
* To Be Completed
* @function Audio.getRecording
* @function Audio.getRecording
*/
Q_INVOKABLE bool getRecording();

8
interface/src/scripting/GooglePolyScriptingInterface.h
View file

@ -28,9 +28,9 @@ public:
public slots:
/**jsdoc
* @function GooglePoly.setAPIKey
* @param {string} key
/**jsdoc
* @function GooglePoly.setAPIKey
* @param {string} key
*/
void setAPIKey(const QString& key);
@ -40,7 +40,7 @@ public slots:
* @param {string} keyword
* @param {string} category
* @param {string} format
* @returns {string}
* @returns {string}
*/
QString getAssetList(const QString& keyword, const QString& category, const QString& format);

22
interface/src/ui/AvatarInputs.h
View file

@ -23,14 +23,14 @@ class AvatarInputs : public QObject {
Q_OBJECT
HIFI_QML_DECL
/**jsdoc
/**jsdoc
* API to help manage your Avatar's input
* @namespace AvatarInputs
* @param {boolean} cameraEnabled
* @namespace AvatarInputs
* @param {boolean} cameraEnabled
* @param {boolean} cameraMuted
* @param {boolean} isHMD
* @param {boolean} showAudioTools
*/
*/
AI_PROPERTY(bool, cameraEnabled, false)
AI_PROPERTY(bool, cameraMuted, false)
@ -44,7 +44,7 @@ public:
/**jsdoc
* @function AvatarInputs.loudnessToAudioLevel
* @param {number} loudness
* @returns {number}
* @returns {number}
*/
Q_INVOKABLE float loudnessToAudioLevel(float loudness);
@ -54,10 +54,10 @@ public:
public slots:
/**jsdoc
* @function AvatarInputs.setShowAudioTools
* @param {boolean} showAudioTools
*/
/**jsdoc
* @function AvatarInputs.setShowAudioTools
* @param {boolean} showAudioTools
*/
void setShowAudioTools(bool showAudioTools);
@ -65,7 +65,7 @@ signals:
/**jsdoc
* @function AvatarInputs.cameraEnabledChanged
* @returns {Signal}
* @returns {Signal}
*/
void cameraEnabledChanged();
@ -86,7 +86,7 @@ signals:
/**jsdoc
* @function AvatarInputs.showAudioToolsChanged
* @param {boolean} show
* @param {boolean} show
* @returns {Signal}
*/

4
libraries/animation/src/AnimationCache.h
View file

@ -35,7 +35,7 @@ class AnimationCache : public ResourceCache, public Dependency {
SINGLETON_DEPENDENCY
public:
// Copied over from ResourceCache (see ResourceCache.h for reason)
// Copied over from ResourceCache (see ResourceCache.h for reason)
/**jsdoc
* @namespace AnimationCache
@ -82,7 +82,7 @@ public:
* @function AnimationCache.getResource
* @returns {Resource}
*/
/**jsdoc
* Prefetches a resource.
* @param url {string} url of resource to load

126
libraries/audio-client/src/AudioIOStats.h
View file

@ -39,47 +39,47 @@ class MixedProcessedAudioStream;
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
*/
/**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
*/
/**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
*/
/**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_PROPERTY(float, lossRate)
AUDIO_PROPERTY(float, lossCount)
@ -112,18 +112,18 @@ private:
class AudioStatsInterface : public QObject {
Q_OBJECT
/**jsdoc
/**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
*/
* @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);
@ -155,24 +155,24 @@ public:
signals:
/**jsdoc
* @function AudioStats.mixerStreamChanged
* @returns {Signal}
*/
/**jsdoc
* @function AudioStats.mixerStreamChanged
* @returns {Signal}
*/
void mixerStreamChanged();
/**jsdoc
* @function AudioStats.clientStreamChanged
* @returns {Signal}
*/
/**jsdoc
* @function AudioStats.clientStreamChanged
* @returns {Signal}
*/
void clientStreamChanged();
/**jsdoc
* @function AudioStats.injectorStreamsChanged
* @returns {Signal}
*/
/**jsdoc
* @function AudioStats.injectorStreamsChanged
* @returns {Signal}
*/
void injectorStreamsChanged();

128
libraries/audio/src/SoundCache.h
View file

@ -28,85 +28,85 @@ class SoundCache : public ResourceCache, public Dependency {
SINGLETON_DEPENDENCY
public:
// Copied over from ResourceCache (see ResourceCache.h for reason)
// 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
*/
/**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
*/
/**jsdoc
* Returns the total number of resources
* @function SoundCache.getNumTotalResources
* @returns {number}
*/
/**jsdoc
* 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}
*/
/**jsdoc
* 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}
*/
/**jsdoc
* 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}
*/
/**jsdoc
* 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[]}
*/
/**jsdoc
* 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
*/
/**jsdoc
* 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}
*/
/**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}
*/
/**jsdoc
* Prefetches a resource.
* @param url {string} url of resource to load
* @function SoundCache.prefetch
* @returns {Resource}
*/
/**jsdoc
* 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}
*/
/**jsdoc
* To Be Completed
* @param {number} deltaSize
* @function SoundCache.updateTotalSize
* @returns {Resource}
*/
/**jsdoc
* @function SoundCache.dirty
* @returns {Signal}
*/
/**jsdoc
* @function SoundCache.dirty
* @returns {Signal}
*/
/**jsdoc
* @function SoundCache.getSound
* @function SoundCache.getSound
* @param {string} url
* @returns {}
*/
*/
Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url);
protected:

22
libraries/avatars/src/AvatarHashMap.h
View file

@ -49,18 +49,18 @@ public:
int size() { return _avatarHash.size(); }
// Currently, your own avatar will be included as the null avatar id.
/**jsdoc
* @function AvatarHashMap.getAvatarIdentifiers
* @function AvatarHashMap.getAvatarIdentifiers
*/
Q_INVOKABLE QVector<QUuid> getAvatarIdentifiers();
/**jsdoc
* @function AvatarHashMap.getAvatarsInRange
* @param {Vec3} position
* @param {Vec3} position
* @param {float} rangeMeters
* @returns {string[]}
* @returns {string[]}
*/
Q_INVOKABLE QVector<QUuid> getAvatarsInRange(const glm::vec3& position, float rangeMeters) const;
@ -68,7 +68,7 @@ public:
/**jsdoc
* @function AvatarHashMap.getAvatar
* @param {string} avatarID
* @returns {ScriptAvatarData}
* @returns {ScriptAvatarData}
*/
// Null/Default-constructed QUuids will return MyAvatar
@ -82,7 +82,7 @@ signals:
/**jsdoc
* @function AvatarHashMap.avatarAddedEvent
* @param {string} sessionUUID
* @returns {Signal}
* @returns {Signal}
*/
void avatarAddedEvent(const QUuid& sessionUUID);
@ -117,11 +117,11 @@ public slots:
protected slots:
/**jsdoc
* @function AvatarHashMap.sessionUUIDChanged
* @param {string} sessionUUID
* @param {string} oldUUID
*/
/**jsdoc
* @function AvatarHashMap.sessionUUIDChanged
* @param {string} sessionUUID
* @param {string} oldUUID
*/
void sessionUUIDChanged(const QUuid& sessionUUID, const QUuid& oldUUID);

4
libraries/model-networking/src/model-networking/TextureCache.h
View file

@ -258,9 +258,9 @@ public:
static const int DEFAULT_SPECTATOR_CAM_HEIGHT { 1024 };
signals:
/**jsdoc
/**jsdoc
* @function TextureCache.spectatorCameraFramebufferReset
* @returns {Signal}
* @returns {Signal}
*/
void spectatorCameraFramebufferReset();

94
libraries/networking/src/ResourceCache.h
View file

@ -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,11 +188,11 @@ 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)
@ -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<Resource> 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.

76
libraries/script-engine/src/AssetScriptingInterface.h
View file

@ -118,40 +118,40 @@ public:
Q_INVOKABLE void sendFakedHandshake();
#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
*/
/**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
*/
/**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
*/
/**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
*/
/**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
*/
/**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
*/
/**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
*/
/**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
*/
Q_INVOKABLE void getAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
@ -162,13 +162,13 @@ public:
* @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
*/
/**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
*/
/**jsdoc
* Called when Assets.putAsset is complete.

18
libraries/trackers/src/trackers/FaceTracker.h
View file

@ -61,9 +61,9 @@ public:
signals:
/**jsdoc
* @function FaceTracker.muteToggled
* @function FaceTracker.muteToggled
* @returns {Signal}
*/
*/
void muteToggled();
@ -75,17 +75,17 @@ public slots:
*/
virtual void setEnabled(bool enabled) = 0;
/**jsdoc
* @function FaceTracker.toggleMute
*/
/**jsdoc
* @function FaceTracker.toggleMute
*/
void toggleMute();
/**jsdoc
* @function FaceTracker.getMuted
/**jsdoc
* @function FaceTracker.getMuted
* @returns {boolean}
*/
*/
bool getMuted() { return _isMuted; }