From cad5b3fb153c69c06d75f2a82e84b1706eacd16b Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Mon, 14 May 2018 09:28:50 +1200
Subject: [PATCH] Expand AudioEffectOptions JSDoc stubs

---
 libraries/audio/src/AudioEffectOptions.cpp | 24 ++++++++++++
 libraries/audio/src/AudioEffectOptions.h   | 44 +++++++++++-----------
 2 files changed, 46 insertions(+), 22 deletions(-)

diff --git a/libraries/audio/src/AudioEffectOptions.cpp b/libraries/audio/src/AudioEffectOptions.cpp
index 9d3ce9299b..edb0ff52ae 100644
--- a/libraries/audio/src/AudioEffectOptions.cpp
+++ b/libraries/audio/src/AudioEffectOptions.cpp
@@ -58,6 +58,30 @@ static void setOption(QScriptValue arguments, const QString name, float defaultV
     variable = arguments.property(name).isNumber() ? (float)arguments.property(name).toNumber() : defaultValue;
 }
 
+/**jsdoc
+ * @typedef {object} AudioEffectOptions.ReverbOptions
+ * @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
+ */
 AudioEffectOptions::AudioEffectOptions(QScriptValue arguments) {
     setOption(arguments, BANDWIDTH_HANDLE, BANDWIDTH_DEFAULT, _bandwidth);
     setOption(arguments, PRE_DELAY_HANDLE, PRE_DELAY_DEFAULT, _preDelay);
diff --git a/libraries/audio/src/AudioEffectOptions.h b/libraries/audio/src/AudioEffectOptions.h
index 18e019731e..1afd4e21be 100644
--- a/libraries/audio/src/AudioEffectOptions.h
+++ b/libraries/audio/src/AudioEffectOptions.h
@@ -17,34 +17,34 @@
 
 /**jsdoc
  * @class AudioEffectOptions
- * @param {object} [properties=null]
+ * @param {AudioEffectOptions.ReverbOptions} [reverbOptions=null]
  *
  * @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
+ * @property {number} bandwidth=10000
+ * @property {number} preDelay=20
+ * @property {number} lateDelay=0
+ * @property {number} reverbTime=2
+ * @property {number} earlyDiffusion=100
+ * @property {number} lateDiffusion=100
+ * @property {number} roomSize=50
+ * @property {number} density=100
+ * @property {number} bassMult=1.5
+ * @property {number} bassFreq=250
+ * @property {number} highGain=-6
+ * @property {number} highFreq=3000
+ * @property {number} modRate=2.3
+ * @property {number} modDepth=50
+ * @property {number} earlyGain=0
+ * @property {number} lateGain=0
+ * @property {number} earlyMixLeft=20
+ * @property {number} earlyMixRight=20
+ * @property {number} lateMixLeft=90
+ * @property {number} lateMixRight=90
+ * @property {number} wetDryMix=50
  */
 
 class AudioEffectOptions : public QObject {