summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Rondeau <tom@trondeau.com>2015-03-13 09:16:56 -0400
committerTom Rondeau <tom@trondeau.com>2015-03-13 09:16:56 -0400
commit60b85d7a8f7ca142287090b3c53fc01c7c612358 (patch)
tree48605a4e8907b3342a538b040f18c8b103c57f67
parentee369b92a5e7de35feb85add091b8ad79cd7d7a2 (diff)
docs: cleaning up some doxygen warnings and formatting.
Diffstat
-rw-r--r--gnuradio-runtime/include/gnuradio/basic_block.h3
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/pub_sink.h10
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/pull_source.h11
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/push_sink.h11
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/rep_sink.h11
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/req_source.h12
-rw-r--r--gr-zeromq/include/gnuradio/zeromq/sub_source.h11
7 files changed, 38 insertions, 31 deletions
diff --git a/gnuradio-runtime/include/gnuradio/basic_block.h b/gnuradio-runtime/include/gnuradio/basic_block.h
index da07dd915f..b687a8f971 100644
--- a/gnuradio-runtime/include/gnuradio/basic_block.h
+++ b/gnuradio-runtime/include/gnuradio/basic_block.h
@@ -254,7 +254,8 @@ namespace gr {
pmt::pmt_t delete_head_nowait( pmt::pmt_t which_port);
/*!
- * \param[in] millisec Optional timeout value (0=no timeout)
+ * \param[in] which_port The message port from which to get the message.
+ * \param[in] millisec Optional timeout value (0=no timeout).
* \returns returns pmt at head of queue or pmt::pmt_t() if empty.
*/
pmt::pmt_t delete_head_blocking(pmt::pmt_t which_port, unsigned int millisec = 0);
diff --git a/gr-zeromq/include/gnuradio/zeromq/pub_sink.h b/gr-zeromq/include/gnuradio/zeromq/pub_sink.h
index 11f251ede2..e8871c22ac 100644
--- a/gr-zeromq/include/gnuradio/zeromq/pub_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/pub_sink.h
@@ -48,12 +48,14 @@ namespace gr {
/*!
* \brief Return a shared_ptr to a new instance of zeromq::pub_sink.
*
- * \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 sink will serialize and pass tags over the link.
*/
- 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
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
diff --git a/gr-zeromq/include/gnuradio/zeromq/push_sink.h b/gr-zeromq/include/gnuradio/zeromq/push_sink.h
index 1b8999e409..0f21b446b4 100644
--- a/gr-zeromq/include/gnuradio/zeromq/push_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/push_sink.h
@@ -49,13 +49,14 @@ namespace gr {
/*!
* \brief Return a shared_ptr to a new instance of gr::zeromq::push_sink
*
- * \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 sink will serialize and pass tags over the link.
*/
- 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
diff --git a/gr-zeromq/include/gnuradio/zeromq/rep_sink.h b/gr-zeromq/include/gnuradio/zeromq/rep_sink.h
index 6d3c47b626..33fd38b2df 100644
--- a/gr-zeromq/include/gnuradio/zeromq/rep_sink.h
+++ b/gr-zeromq/include/gnuradio/zeromq/rep_sink.h
@@ -47,13 +47,14 @@ namespace gr {
/*!
* \brief Return a shared_ptr to a new instance of zeromq::rep_sink.
*
- * \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 sink will serialize and pass tags over the link.
*/
- 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
diff --git a/gr-zeromq/include/gnuradio/zeromq/req_source.h b/gr-zeromq/include/gnuradio/zeromq/req_source.h
index d9f55d3c72..9936406c23 100644
--- a/gr-zeromq/include/gnuradio/zeromq/req_source.h
+++ b/gr-zeromq/include/gnuradio/zeromq/req_source.h
@@ -45,14 +45,14 @@ namespace gr {
/*!
* \brief Return a shared_ptr to a new instance of zeromq::req_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
diff --git a/gr-zeromq/include/gnuradio/zeromq/sub_source.h b/gr-zeromq/include/gnuradio/zeromq/sub_source.h
index f97dc5ac2c..5fdd8932ec 100644
--- a/gr-zeromq/include/gnuradio/zeromq/sub_source.h
+++ b/gr-zeromq/include/gnuradio/zeromq/sub_source.h
@@ -45,13 +45,14 @@ namespace gr {
/*!
* \brief Return a shared_ptr to a new instance of gr::zeromq::sub_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
generated by cgit v1.2.3 (git 2.39.1) at 2025-03-29 10:37:57 +0000