From d30aa26c70e8830b86b52b0f4fc851fc15eff6e0 Mon Sep 17 00:00:00 2001
From: Paul Ferrand <paulfd@outlook.fr>
Date: Sat, 30 Nov 2019 00:53:22 +0100
Subject: [PATCH] Documented the one pole filter

---
 src/sfizz/OnePoleFilter.h | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/sfizz/OnePoleFilter.h b/src/sfizz/OnePoleFilter.h
index 72c71c3e..9c3afd0f 100644
--- a/src/sfizz/OnePoleFilter.h
+++ b/src/sfizz/OnePoleFilter.h
@@ -29,6 +29,12 @@
 
 namespace sfz
 {
+/**
+ * @brief An implementation of a one pole filter. This is a scalar
+ * implementation.
+ *
+ * @tparam Type the underlying type of the filter.
+ */
 template <class Type = float>
 class OnePoleFilter {
 public:
@@ -137,4 +143,4 @@ private:
         state += 2 * intermediate;
     }
 };
-}
\ No newline at end of file
+}