From 2270255d88fdaa4c23051e9b45f48471c862717d Mon Sep 17 00:00:00 2001 From: David Rowe Date: Sat, 4 Aug 2018 07:22:12 +1200 Subject: [PATCH] JSDoc review --- libraries/audio/src/SoundCacheScriptingInterface.h | 7 ++++--- libraries/script-engine/src/AudioScriptingInterface.h | 3 ++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/libraries/audio/src/SoundCacheScriptingInterface.h b/libraries/audio/src/SoundCacheScriptingInterface.h index 9e660a2d04..c985e8c211 100644 --- a/libraries/audio/src/SoundCacheScriptingInterface.h +++ b/libraries/audio/src/SoundCacheScriptingInterface.h @@ -48,10 +48,11 @@ public: SoundCacheScriptingInterface(); /**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 - * @param {string} url - The URL of the audio file to load. See {@link SoundObject} for supported formats. - * @returns {SoundObject} + * @param {string} url - The URL of the audio file to load — Web, ATP, or file. See {@link SoundObject} for supported + * formats. + * @returns {SoundObject} The sound ready for playback. */ Q_INVOKABLE SharedSoundPointer getSound(const QUrl& url); }; diff --git a/libraries/script-engine/src/AudioScriptingInterface.h b/libraries/script-engine/src/AudioScriptingInterface.h index 72b9541763..1220a9b769 100644 --- a/libraries/script-engine/src/AudioScriptingInterface.h +++ b/libraries/script-engine/src/AudioScriptingInterface.h @@ -98,7 +98,8 @@ signals: void mutedByMixer(); /**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 * @returns {Signal} */