diff options
Diffstat (limited to 'gr-input/doc')
-rw-r--r-- | gr-input/doc/CMakeLists.txt | 23 | ||||
-rw-r--r-- | gr-input/doc/README.input | 2 | ||||
-rw-r--r-- | gr-input/doc/input.dox | 29 |
3 files changed, 54 insertions, 0 deletions
diff --git a/gr-input/doc/CMakeLists.txt b/gr-input/doc/CMakeLists.txt new file mode 100644 index 000000000..b10223aaf --- /dev/null +++ b/gr-input/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.input + DESTINATION ${GR_PKG_DOC_DIR} +) diff --git a/gr-input/doc/README.input b/gr-input/doc/README.input new file mode 100644 index 000000000..1bd326897 --- /dev/null +++ b/gr-input/doc/README.input @@ -0,0 +1,2 @@ +Serial Python block + diff --git a/gr-input/doc/input.dox b/gr-input/doc/input.dox new file mode 100644 index 000000000..8843d0560 --- /dev/null +++ b/gr-input/doc/input.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 + +*/ |