diff options
author | Johnathan Corgan | 2012-03-22 15:24:38 -0700 |
---|---|---|
committer | Johnathan Corgan | 2012-03-22 15:24:38 -0700 |
commit | 2e5519b642217fc83324360596ea834cff414ce3 (patch) | |
tree | 2d976fc654447983dc1414e7a038d076ded20751 /gr-fcd/doc | |
parent | a21499503e97189644b882ec12210ed4fa501414 (diff) | |
parent | fc115e6aa0c22af172cbfcb50c895a03218819ba (diff) | |
download | gnuradio-2e5519b642217fc83324360596ea834cff414ce3.tar.gz gnuradio-2e5519b642217fc83324360596ea834cff414ce3.tar.bz2 gnuradio-2e5519b642217fc83324360596ea834cff414ce3.zip |
Merge branch 'master' into next
Conflicts:
config/Makefile.am
configure.ac
Diffstat (limited to 'gr-fcd/doc')
-rw-r--r-- | gr-fcd/doc/CMakeLists.txt | 23 | ||||
-rw-r--r-- | gr-fcd/doc/README.fcd | 13 | ||||
-rw-r--r-- | gr-fcd/doc/fcd.dox | 29 |
3 files changed, 65 insertions, 0 deletions
diff --git a/gr-fcd/doc/CMakeLists.txt b/gr-fcd/doc/CMakeLists.txt new file mode 100644 index 000000000..d080b384e --- /dev/null +++ b/gr-fcd/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.fcd + DESTINATION ${GR_PKG_DOC_DIR} +) diff --git a/gr-fcd/doc/README.fcd b/gr-fcd/doc/README.fcd new file mode 100644 index 000000000..6fff012b8 --- /dev/null +++ b/gr-fcd/doc/README.fcd @@ -0,0 +1,13 @@ +This is the gr-fcd package. It contains a source block for the +FunCube Dongle hardware. + +The Python namespace is in gnuradio.qtgui, which would be normally +imported as: + + from gnuradio import fcd + +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(fcd) diff --git a/gr-fcd/doc/fcd.dox b/gr-fcd/doc/fcd.dox new file mode 100644 index 000000000..a4420f6b3 --- /dev/null +++ b/gr-fcd/doc/fcd.dox @@ -0,0 +1,29 @@ +/*! \page page_fcd FunCube Dongle Source + +\section Introduction + +This is the gr-fcd package. It contains a source block for the +FunCube Dongle hardware. + +The Python namespace is in gnuradio.qtgui, which would be normally +imported as: + +\code + from gnuradio import fcd +\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(fcd) +\endcode + +\section Dependencies + +The FCD blocks require the following dependencies. + +\li libusb-1.0 (version >= 1.0) + +*/ |