summaryrefslogtreecommitdiff
path: root/gr-blocks/docs/blocks.dox
diff options
context:
space:
mode:
Diffstat (limited to 'gr-blocks/docs/blocks.dox')
-rw-r--r--gr-blocks/docs/blocks.dox24
1 files changed, 24 insertions, 0 deletions
diff --git a/gr-blocks/docs/blocks.dox b/gr-blocks/docs/blocks.dox
new file mode 100644
index 0000000000..fb7d3e67ab
--- /dev/null
+++ b/gr-blocks/docs/blocks.dox
@@ -0,0 +1,24 @@
+/*! \page page_blocks Standard GNU Radio Blocks
+
+\section blocks_introduction Introduction
+
+This is the gr-blocks package. It contains many of the generic,
+standard, or simple blocks used for many aspects of building GNU Radio
+flowgraphs. To use these blocks, the Python module is
+gnuradio.blocks, which would be normally imported as:
+
+\code
+ from gnuradio import blocks
+\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(blocks)
+\endcode
+
+*/