Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-09 04:57:58 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

JSDoc review

Browse source
This commit is contained in:
David Rowe 2018-08-04 07:22:12 +12:00
parent 32e3bb0e1d
commit 2270255d88
2 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
libraries/audio/src/SoundCacheScriptingInterface.h
View file

@ -48,10 +48,11 @@ public:
SoundCacheScriptingInterface(); SoundCacheScriptingInterface();
/**jsdoc /**jsdoc
* Loads the content of an audio file into an object, ready for playback by {@link Audio.playSound}. * Loads the content of an audio file into a {@link SoundObject}, ready for playback by {@link Audio.playSound}.
* @function SoundCache.getSound * @function SoundCache.getSound
* @param {string} url - The URL of the audio file to load. See {@link SoundObject} for supported formats. * @param {string} url - The URL of the audio file to load — Web, ATP, or file. See {@link SoundObject} for supported
* @returns {SoundObject} * formats.
* @returns {SoundObject} The sound ready for playback.
*/ */
Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url); Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url);
}; };

3
libraries/script-engine/src/AudioScriptingInterface.h
View file

@ -98,7 +98,8 @@ signals:
void mutedByMixer(); void mutedByMixer();
/**jsdoc /**jsdoc
* Triggered when everyone is muted by the mixer. * Triggered when the client is muted by the mixer because they're within a certain radius (50m) of someone who requested
* the mute through Developer > Audio > Mute Environment.
* @function Audio.environmentMuted * @function Audio.environmentMuted
* @returns {Signal} * @returns {Signal}
*/ */