summaryrefslogtreecommitdiff
path: root/gr-scigen/doc/scigen.dox
diff options
context:
space:
mode:
authormanojgudi2013-10-07 14:04:07 +0530
committermanojgudi2013-10-07 14:04:07 +0530
commite9576e44ef8f0ad67d8cd8a4e025a0f8da0727f8 (patch)
tree3a77657667b4ef037f712ee68a5ec86c86cba5c5 /gr-scigen/doc/scigen.dox
parented97c528ce61496e10d612a4f5e9aef509b65ccf (diff)
downloadgnuradio-e9576e44ef8f0ad67d8cd8a4e025a0f8da0727f8.tar.gz
gnuradio-e9576e44ef8f0ad67d8cd8a4e025a0f8da0727f8.tar.bz2
gnuradio-e9576e44ef8f0ad67d8cd8a4e025a0f8da0727f8.zip
added gr-scimod block+CMake change | compiles fine
Diffstat (limited to 'gr-scigen/doc/scigen.dox')
-rw-r--r--gr-scigen/doc/scigen.dox29
1 files changed, 29 insertions, 0 deletions
diff --git a/gr-scigen/doc/scigen.dox b/gr-scigen/doc/scigen.dox
new file mode 100644
index 000000000..8843d0560
--- /dev/null
+++ b/gr-scigen/doc/scigen.dox
@@ -0,0 +1,29 @@
+/*! \page page_fft FFT Signal Processing Blocks
+
+\section Introduction
+
+This is the gr-scigen 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 scigen
+\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(scigen)
+\endcode
+
+\section Dependencies
+
+The scigen blocks require the following dependencies.
+
+\li fftw3f (>= 3.0) http://www.fftw.org/download.html
+
+*/