summaryrefslogtreecommitdiff
path: root/gr-fft/doc/fft.dox
diff options
context:
space:
mode:
Diffstat (limited to 'gr-fft/doc/fft.dox')
-rw-r--r--gr-fft/doc/fft.dox29
1 files changed, 29 insertions, 0 deletions
diff --git a/gr-fft/doc/fft.dox b/gr-fft/doc/fft.dox
new file mode 100644
index 000000000..5bf612d84
--- /dev/null
+++ b/gr-fft/doc/fft.dox
@@ -0,0 +1,29 @@
+/*! \page page_fft FFT Signal Processing Blocks
+
+\section Introduction
+
+This is the gr-fft package. It contains signal processing blocks to
+perform FFTs and FFT-related functionality.
+
+The Python namespace is in gnuradio.fft, which would be normally
+imported as:
+
+\code
+ from gnuradio import fft
+\endcode
+
+See the Doxygen documentation for details about the blocks available
+in this package. A quick listing of the details can be found in Python
+after importing by using:
+
+\code
+ help(fft)
+\endcode
+
+\section Dependencies
+
+The FFT blocks require the following dependencies.
+
+\li fftw3f (>= 3.0) http://www.fftw.org/download.html
+
+*/