3D Audio GSoC:

Code documentation.

Also:
* Fix: rlint for MSVC.
* Minor other small fixes/changes.

1 files changed, 16 insertions, 0 deletions

diff --git a/intern/audaspace/FX/AUD_DynamicIIRFilterFactory.h b/intern/audaspace/FX/AUD_DynamicIIRFilterFactory.h
index 19c1a0f0a54..56d56a977d4 100644
--- a/intern/audaspace/FX/AUD_DynamicIIRFilterFactory.h
+++ b/intern/audaspace/FX/AUD_DynamicIIRFilterFactory.h
@@ -34,13 +34,29 @@
 #include "AUD_EffectFactory.h"
 #include <vector>
 
+/**
+ * This factory creates a IIR filter reader.
+ *
+ * This means that on sample rate change the filter recalculates its
+ * coefficients.
+ */
 class AUD_DynamicIIRFilterFactory : public AUD_EffectFactory
 {
 public:
+	/**
+	 * Creates a new Dynmic IIR filter factory.
+	 * \param factory The input factory.
+	 */
 	AUD_DynamicIIRFilterFactory(AUD_Reference<AUD_IFactory> factory);
 
 	virtual AUD_Reference<AUD_IReader> createReader();
 
+	/**
+	 * Recalculates the filter coefficients.
+	 * \param rate The sample rate of the audio data.
+	 * \param[out] b The input filter coefficients.
+	 * \param[out] a The output filter coefficients.
+	 */
 	virtual void recalculateCoefficients(AUD_SampleRate rate,
 										 std::vector<float>& b,
 										 std::vector<float>& a)=0;