summaryrefslogtreecommitdiff
path: root/gr-channels/doc/channels.dox
diff options
context:
space:
mode:
Diffstat (limited to 'gr-channels/doc/channels.dox')
-rw-r--r--gr-channels/doc/channels.dox23
1 files changed, 23 insertions, 0 deletions
diff --git a/gr-channels/doc/channels.dox b/gr-channels/doc/channels.dox
new file mode 100644
index 0000000000..c4440b45b0
--- /dev/null
+++ b/gr-channels/doc/channels.dox
@@ -0,0 +1,23 @@
+/*! \page page_channels Channel Model Blocks
+
+\section Introduction
+
+This is the gr-channels package. It contains signal processing blocks to
+simulate channel models.
+
+The Python namespace is in gnuradio.channels, which would be normally
+imported as:
+
+\code
+ from gnuradio import channels
+\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(channels)
+\endcode
+
+*/