From 0cc9a67b476d0fc8c9d0ff489c6f830b04fdd0bf Mon Sep 17 00:00:00 2001
From: Carles Fernandez <carles.fernandez@gmail.com>
Date: Sat, 16 Jun 2012 22:32:43 +0000
Subject: [PATCH] Added documentation

git-svn-id: https://svn.code.sf.net/p/gnss-sdr/code/trunk@197 64b25241-fba3-4117-9849-534c7e92360d
---
 src/algorithms/input_filter/adapters/fir_filter.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/algorithms/input_filter/adapters/fir_filter.h b/src/algorithms/input_filter/adapters/fir_filter.h
index e0c7d3fc4..63596594c 100644
--- a/src/algorithms/input_filter/adapters/fir_filter.h
+++ b/src/algorithms/input_filter/adapters/fir_filter.h
@@ -45,6 +45,14 @@
 
 class ConfigurationInterface;
 
+/*!
+ * \brief This class adapts a GNU Radio gr_fir_filter designed with gr_remez
+ *
+ * See Parks-McClellan FIR filter design, http://en.wikipedia.org/wiki/Parks-McClellan_filter_design_algorithm
+ * Calculates the optimal (in the Chebyshev/minimax sense) FIR filter impulse response
+ * given a set of band edges, the desired response on those bands, and the weight given
+ * to the error in those bands.
+ */
 class FirFilter: public GNSSBlockInterface
 {