summaryrefslogtreecommitdiff
path: root/gr-zeromq/docs/zeromq.dox
diff options
context:
space:
mode:
Diffstat (limited to 'gr-zeromq/docs/zeromq.dox')
-rw-r--r--gr-zeromq/docs/zeromq.dox22
1 files changed, 22 insertions, 0 deletions
diff --git a/gr-zeromq/docs/zeromq.dox b/gr-zeromq/docs/zeromq.dox
new file mode 100644
index 0000000000..3709afc4b0
--- /dev/null
+++ b/gr-zeromq/docs/zeromq.dox
@@ -0,0 +1,22 @@
+/*! \page page_zeromq ZeroMQ
+
+\section Introduction
+
+This is the gr-zeromq package. It contains bindings for ZeroMQ.
+
+The Python namespace is in gnuradio.zeromq, which would be normally
+imported as:
+
+\code
+ from gnuradio import zeromq
+\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(zeromq)
+\endcode
+
+*/