diff options
| author | Tom Rondeau <tom@trondeau.com> | 2015-03-13 09:16:56 -0400 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2015-03-13 09:16:56 -0400 |
| commit | 60b85d7a8f7ca142287090b3c53fc01c7c612358 (patch) | |
| tree | 48605a4e8907b3342a538b040f18c8b103c57f67 /gr-zeromq/include/gnuradio/zeromq/pull_source.h | |
| parent | ee369b92a5e7de35feb85add091b8ad79cd7d7a2 (diff) | |
docs: cleaning up some doxygen warnings and formatting.
Diffstat (limited to 'gr-zeromq/include/gnuradio/zeromq/pull_source.h')
| -rw-r--r-- | gr-zeromq/include/gnuradio/zeromq/pull_source.h | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/gr-zeromq/include/gnuradio/zeromq/pull_source.h b/gr-zeromq/include/gnuradio/zeromq/pull_source.h index 6dec9c2b34..ca7b40726d 100644 --- a/gr-zeromq/include/gnuradio/zeromq/pull_source.h +++ b/gr-zeromq/include/gnuradio/zeromq/pull_source.h @@ -45,13 +45,14 @@ namespace gr { /*! * \brief Return a shared_ptr to a new instance of gr::zeromq::pull_source. * - * \param itemsize Size of a stream item in bytes + * \param itemsize Size of a stream item in bytes. * \param vlen Vector length of the input items. Note that one vector is one item. - * \param address ZMQ socket address specifier - * \param timeout Receive timeout in seconds, default is 100ms, 1us increments - * + * \param address ZMQ socket address specifier. + * \param timeout Receive timeout in seconds, default is 100ms, 1us increments. + * \param pass_tags Whether source will look for and deserialize tags. */ - static sptr make(size_t itemsize, size_t vlen, char *address, int timeout=100, bool pass_tags=false); + static sptr make(size_t itemsize, size_t vlen, char *address, + int timeout=100, bool pass_tags=false); }; } // namespace zeromq |