summaryrefslogtreecommitdiff
path: root/gr-blocks/doc/blocks.dox
diff options
context:
space:
mode:
authorJohnathan Corgan2012-10-01 16:00:32 -0700
committerJohnathan Corgan2012-10-01 16:00:32 -0700
commitd5973006fa99ead50dd4b74e01aec19fc69f228a (patch)
tree86c0c9a26fbc9940510a64014dd4cb0923233959 /gr-blocks/doc/blocks.dox
parentb31ea99bf07cb66f1dab3cea94f9f792f6cab2fc (diff)
parent9f72b877043cd6e5d8e7cee20c0e4390419a94b7 (diff)
downloadgnuradio-d5973006fa99ead50dd4b74e01aec19fc69f228a.tar.gz
gnuradio-d5973006fa99ead50dd4b74e01aec19fc69f228a.tar.bz2
gnuradio-d5973006fa99ead50dd4b74e01aec19fc69f228a.zip
Merge branch 'wip/gr-blocks-master'
Diffstat (limited to 'gr-blocks/doc/blocks.dox')
-rw-r--r--gr-blocks/doc/blocks.dox23
1 files changed, 23 insertions, 0 deletions
diff --git a/gr-blocks/doc/blocks.dox b/gr-blocks/doc/blocks.dox
new file mode 100644
index 000000000..110dcb677
--- /dev/null
+++ b/gr-blocks/doc/blocks.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
+
+*/