diff options
| author | Martin Braun <martin.braun@ettus.com> | 2014-07-16 11:41:52 +0200 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2014-07-22 21:38:47 +0200 |
| commit | a9c3d8ff3bc31117309004c16860d18f26369311 (patch) | |
| tree | 4566e2c2cf868bb471a6cc81e3148a3aef1b061a /gr-zeromq | |
| parent | d09b971d01f4e65eff80065796d724d88168866d (diff) | |
docs: Restructured intro page, added some manual pages
Diffstat (limited to 'gr-zeromq')
| -rw-r--r-- | gr-zeromq/docs/zeromq.dox | 22 |
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 + +*/ |