diff options
author | manojgudi | 2013-10-07 14:04:07 +0530 |
---|---|---|
committer | manojgudi | 2013-10-07 14:04:07 +0530 |
commit | e9576e44ef8f0ad67d8cd8a4e025a0f8da0727f8 (patch) | |
tree | 3a77657667b4ef037f712ee68a5ec86c86cba5c5 /gr-scigen/doc | |
parent | ed97c528ce61496e10d612a4f5e9aef509b65ccf (diff) | |
download | gnuradio-e9576e44ef8f0ad67d8cd8a4e025a0f8da0727f8.tar.gz gnuradio-e9576e44ef8f0ad67d8cd8a4e025a0f8da0727f8.tar.bz2 gnuradio-e9576e44ef8f0ad67d8cd8a4e025a0f8da0727f8.zip |
added gr-scimod block+CMake change | compiles fine
Diffstat (limited to 'gr-scigen/doc')
-rw-r--r-- | gr-scigen/doc/CMakeLists.txt | 23 | ||||
-rw-r--r-- | gr-scigen/doc/README.scigen | 13 | ||||
-rw-r--r-- | gr-scigen/doc/scigen.dox | 29 |
3 files changed, 65 insertions, 0 deletions
diff --git a/gr-scigen/doc/CMakeLists.txt b/gr-scigen/doc/CMakeLists.txt new file mode 100644 index 000000000..80ce59153 --- /dev/null +++ b/gr-scigen/doc/CMakeLists.txt @@ -0,0 +1,23 @@ +# Copyright 2012 Free Software Foundation, Inc. +# +# This file is part of GNU Radio +# +# GNU Radio is free software; you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation; either version 3, or (at your option) +# any later version. +# +# GNU Radio is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with GNU Radio; see the file COPYING. If not, write to +# the Free Software Foundation, Inc., 51 Franklin Street, +# Boston, MA 02110-1301, USA. + +install( + FILES README.scigen + DESTINATION ${GR_PKG_DOC_DIR} +) diff --git a/gr-scigen/doc/README.scigen b/gr-scigen/doc/README.scigen new file mode 100644 index 000000000..61e8f6bf8 --- /dev/null +++ b/gr-scigen/doc/README.scigen @@ -0,0 +1,13 @@ +This is the gr-scigen package. It contains signal processing blocks to +perform FFTs and FFT-related functionality. + +The Python namespace is in gnuradio.scigen, which would be normally +imported as: + + from gnuradio import scigen + +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: + + help(scigen) 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 + +*/ |