summaryrefslogtreecommitdiff
path: root/gr-blocks/doc/blocks.dox
diff options
context:
space:
mode:
authorJohnathan Corgan <jcorgan@corganenterprises.com>2012-05-05 13:21:38 -0700
committerJohnathan Corgan <jcorgan@corganenterprises.com>2012-06-08 07:44:57 -0700
commit630cd06cb33d628fa6426866f006580aad30f84b (patch)
treebb3e819ebcec9a4b6100a43c026d5104481182a7 /gr-blocks/doc/blocks.dox
parent9038efc67028ac6bab05bfd60a8de7e6c2ba3fd7 (diff)
blocks: adds new top-level component gr-blocks with first block
gr::blocks::add_XX
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 0000000000..110dcb677e
--- /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
+
+*/