From bc8a3bde9b1e6c30ec5fd3d18fea299ac613f404 Mon Sep 17 00:00:00 2001
From: Tom Rondeau <trondeau@vt.edu>
Date: Sun, 28 Feb 2010 18:39:59 -0500
Subject: [PATCH] Adding Doxygen comments to new FFT filter blocks.

---
 .../src/lib/filter/gri_fft_filter_ccc.h       | 25 +++++++++++++++++++
 .../src/lib/filter/gri_fft_filter_fff.h       | 21 ++++++++++++++++
 2 files changed, 46 insertions(+)

diff --git a/gnuradio-core/src/lib/filter/gri_fft_filter_ccc.h b/gnuradio-core/src/lib/filter/gri_fft_filter_ccc.h
index a65a3b0e..a857e5ab 100644
--- a/gnuradio-core/src/lib/filter/gri_fft_filter_ccc.h
+++ b/gnuradio-core/src/lib/filter/gri_fft_filter_ccc.h
@@ -28,6 +28,10 @@
 
 class gri_fft_complex;
 
+/*!
+ * \brief Fast FFT filter with gr_complex input, gr_complex output and gr_complex taps
+ * \ingroup filter_blk
+ */
 class gri_fft_filter_ccc
 {
  private:
@@ -45,11 +49,32 @@ class gri_fft_filter_ccc
   int tailsize() const { return d_ntaps - 1; }
   
  public:
+  /*!
+   * \brief Construct an FFT filter for complex vectors with the given taps and decimation rate.
+   *
+   * This is the basic implementation for performing FFT filter for fast convolution
+   * in other blocks for complex vectors (such as gr_fft_filter_ccc).
+   * \param decimation The decimation rate of the filter (int)
+   * \param taps       The filter taps (complex)
+   */
   gri_fft_filter_ccc (int decimation, const std::vector<gr_complex> &taps);
   ~gri_fft_filter_ccc ();
 
+  /*!
+   * \brief Set new taps for the filter.
+   *
+   * Sets new taps and resets the class properties to handle different sizes
+   * \param taps       The filter taps (complex)
+   */
   int set_taps (const std::vector<gr_complex> &taps);
   
+  /*!
+   * \brief Perform the filter operation
+   *
+   * \param nitems  The number of items to produce
+   * \param input   The input vector to be filtered
+   * \param output  The result of the filter operation
+   */
   int filter (int nitems, const gr_complex *input, gr_complex *output);
 
 };
diff --git a/gnuradio-core/src/lib/filter/gri_fft_filter_fff.h b/gnuradio-core/src/lib/filter/gri_fft_filter_fff.h
index 35a2d231..2f6b7e45 100644
--- a/gnuradio-core/src/lib/filter/gri_fft_filter_fff.h
+++ b/gnuradio-core/src/lib/filter/gri_fft_filter_fff.h
@@ -46,11 +46,32 @@ class gri_fft_filter_fff
   int tailsize() const { return d_ntaps - 1; }
   
  public:
+  /*!
+   * \brief Construct a FFT filter for float vectors with the given taps and decimation rate.
+   *
+   * This is the basic implementation for performing FFT filter for fast convolution
+   * in other blocks for floating point vectors (such as gr_fft_filter_fff).
+   * \param decimation The decimation rate of the filter (int)
+   * \param taps       The filter taps (float)
+   */
   gri_fft_filter_fff (int decimation, const std::vector<float> &taps);
   ~gri_fft_filter_fff ();
 
+  /*!
+   * \brief Set new taps for the filter.
+   *
+   * Sets new taps and resets the class properties to handle different sizes
+   * \param taps       The filter taps (float)
+   */
   int set_taps (const std::vector<float> &taps);
   
+  /*!
+   * \brief Perform the filter operation
+   *
+   * \param nitems  The number of items to produce
+   * \param input   The input vector to be filtered
+   * \param output  The result of the filter operation
+   */
   int filter (int nitems, const float *input, float *output);
 
 };
-- 
2.30.2