diff options
author | Johnathan Corgan | 2012-06-20 07:58:00 -0700 |
---|---|---|
committer | Johnathan Corgan | 2012-06-20 07:58:00 -0700 |
commit | 2036030273d1c4842670ca3b2bd96e72aa408c9e (patch) | |
tree | 46d627b9a6114d3f2ac5c52f2d430d5bec800818 /gr-filter/doc | |
parent | 439b427e80ebc767db6e4e732213d89c2a6febd4 (diff) | |
parent | 446494ea3bb021cb0b423c13bde2689c5046fe39 (diff) | |
download | gnuradio-2036030273d1c4842670ca3b2bd96e72aa408c9e.tar.gz gnuradio-2036030273d1c4842670ca3b2bd96e72aa408c9e.tar.bz2 gnuradio-2036030273d1c4842670ca3b2bd96e72aa408c9e.zip |
Merge branch 'master' into wip/gr-blocks-master
Diffstat (limited to 'gr-filter/doc')
-rw-r--r-- | gr-filter/doc/CMakeLists.txt | 23 | ||||
-rw-r--r-- | gr-filter/doc/README.filter | 13 | ||||
-rw-r--r-- | gr-filter/doc/filter.dox | 27 |
3 files changed, 63 insertions, 0 deletions
diff --git a/gr-filter/doc/CMakeLists.txt b/gr-filter/doc/CMakeLists.txt new file mode 100644 index 000000000..63447ed2c --- /dev/null +++ b/gr-filter/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.filter + DESTINATION ${GR_PKG_DOC_DIR} +) diff --git a/gr-filter/doc/README.filter b/gr-filter/doc/README.filter new file mode 100644 index 000000000..776acd46c --- /dev/null +++ b/gr-filter/doc/README.filter @@ -0,0 +1,13 @@ +This is the gr-filter package. It contains signal processing blocks to +perform filtering operations. + +The Python namespace is in gnuradio.filter, which would be normally +imported as: + + from gnuradio import filter + +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(filter) diff --git a/gr-filter/doc/filter.dox b/gr-filter/doc/filter.dox new file mode 100644 index 000000000..fc3b52e91 --- /dev/null +++ b/gr-filter/doc/filter.dox @@ -0,0 +1,27 @@ +/*! \page page_filter filter Signal Processing Blocks + +\section Introduction + +This is the gr-filter package. It contains signal processing blocks to +perform filtering operations. + +The Python namespace is in gnuradio.filter, which would be normally +imported as: + +\code + from gnuradio import filter +\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(filter) +\endcode + +\section Dependencies + +The filter blocks depend on \ref page_fft. + +*/ |