diff options
| author | Johnathan Corgan <johnathan@corganlabs.com> | 2012-11-12 20:36:05 -0800 |
|---|---|---|
| committer | Johnathan Corgan <johnathan@corganlabs.com> | 2012-11-12 20:36:05 -0800 |
| commit | ce1213e615023fa5c43f75ba2d2ec54649025b8f (patch) | |
| tree | 8567615201922dc4f1196a965161f4bba0e24dd7 /gr-fec/doc | |
| parent | 5b568abe194f027860670317915c27c174fab52e (diff) | |
fec: add new top-level component for FEC blocks
Removed viterbi and reed-solomon from gnuradio-core
Diffstat (limited to 'gr-fec/doc')
| -rw-r--r-- | gr-fec/doc/CMakeLists.txt | 23 | ||||
| -rw-r--r-- | gr-fec/doc/README.fec | 12 | ||||
| -rw-r--r-- | gr-fec/doc/fec.dox | 23 |
3 files changed, 58 insertions, 0 deletions
diff --git a/gr-fec/doc/CMakeLists.txt b/gr-fec/doc/CMakeLists.txt new file mode 100644 index 0000000000..776f1e2159 --- /dev/null +++ b/gr-fec/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.fec + DESTINATION ${GR_PKG_DOC_DIR} +) diff --git a/gr-fec/doc/README.fec b/gr-fec/doc/README.fec new file mode 100644 index 0000000000..02374bca84 --- /dev/null +++ b/gr-fec/doc/README.fec @@ -0,0 +1,12 @@ +This is the gr-fec package. It contains all of the FEC +encoders and decoders. To use the FEC blocks, the Python +namespace is in gnuradio.fec, which would be normally +imported as: + + from gnuradio import fec + +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(fec) diff --git a/gr-fec/doc/fec.dox b/gr-fec/doc/fec.dox new file mode 100644 index 0000000000..110dcb677e --- /dev/null +++ b/gr-fec/doc/fec.dox @@ -0,0 +1,23 @@ +/*! \page page_digital Digital Modulation + +\section Introduction +This is the gr-digital package. It contains all of the digital +modulation blocks, utilities, and examples. To use the digital blocks, +the Python namespaces is in gnuradio.digital, which would be normally +imported as: + +\code + from gnuradio import digital +\endcode + +See the Doxygen documentation for details about the blocks available +in this package. The relevant blocks are listed in the \ref digital group. + +A quick listing of the details can be found in Python after importing +by using: + +\code + help(digital) +\endcode + +*/ |