From fb175d7110a8c2b4901cdaaefd9ef12c7fc55172 Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Fri, 11 May 2018 20:36:10 +1200
Subject: [PATCH] AudioEffectOptions API JSDoc stubs

---
 interface/src/scripting/Audio.h          |  2 +-
 libraries/audio/src/AudioEffectOptions.h | 31 ++++++++++++++++++++++++
 2 files changed, 32 insertions(+), 1 deletion(-)

diff --git a/interface/src/scripting/Audio.h b/interface/src/scripting/Audio.h
index f0a4328c2f..8d16b06995 100644
--- a/interface/src/scripting/Audio.h
+++ b/interface/src/scripting/Audio.h
@@ -89,7 +89,7 @@ public:
     
     /**jsdoc
      * @function Audio.setReverbOptions
-     * @param {} options
+     * @param {AudioEffectOptions} options
      */
     Q_INVOKABLE void setReverbOptions(const AudioEffectOptions* options);
    
diff --git a/libraries/audio/src/AudioEffectOptions.h b/libraries/audio/src/AudioEffectOptions.h
index 9a65301473..09f8afc2b9 100644
--- a/libraries/audio/src/AudioEffectOptions.h
+++ b/libraries/audio/src/AudioEffectOptions.h
@@ -15,6 +15,37 @@
 #include <QtScript/QScriptContext>
 #include <QtScript/QScriptEngine>
 
+/**jsdoc
+ * @class AudioEffectOptions
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
+ *
+ * @property {number} bandwidth
+ * @property {number} preDelay
+ * @property {number} lateDelay
+ * @property {number} reverbTime
+ * @property {number} earlyDiffusion
+ * @property {number} lateDiffusion
+ * @property {number} roomSize
+ * @property {number} density
+ * @property {number} bassMult
+ * @property {number} bassFreq
+ * @property {number} highGain
+ * @property {number} highFreq
+ * @property {number} modRate
+ * @property {number} modDepth
+ * @property {number} earlyGain
+ * @property {number} lateGain
+ * @property {number} earlyMixLeft
+ * @property {number} earlyMixRight
+ * @property {number} lateMixLeft
+ * @property {number} lateMixRight
+ * @property {number} wetDryMix
+ */
+
 class AudioEffectOptions : public QObject {
     Q_OBJECT