diff options
| author | Tom Rondeau <tom@trondeau.com> | 2014-02-23 11:25:57 -0500 |
|---|---|---|
| committer | Tom Rondeau <tom@trondeau.com> | 2014-02-23 11:25:57 -0500 |
| commit | b5fcc18523caeafebbf117cf2c838e7974856966 (patch) | |
| tree | aac43972eb74614cded00b37d2d76c9113fa66a2 /gr-blocks/include/gnuradio/blocks/vector_source_X.h.t | |
| parent | 77c36d3cc3bb61581621dd61aab97a9b5d1b044e (diff) | |
tags: adds get_tags_in_window helper function for handling tags. Also updates some docs.
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/vector_source_X.h.t')
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/vector_source_X.h.t | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/vector_source_X.h.t b/gr-blocks/include/gnuradio/blocks/vector_source_X.h.t index 7ff18ad083..9751514d7f 100644 --- a/gr-blocks/include/gnuradio/blocks/vector_source_X.h.t +++ b/gr-blocks/include/gnuradio/blocks/vector_source_X.h.t @@ -32,8 +32,19 @@ namespace gr { namespace blocks { /*! - * \brief source of @TYPE@'s that gets its data from a vector + * \brief Source that streams @TYPE@ items based on the input \data vector. * \ingroup misc_blk + * + * \details + * This block produces a stream of samples based on an input + * vector. In C++, this is a std::vector<@TYPE@>, and in Python, + * this is either a list or tuple. The data can repeat infinitely + * until the flowgraph is terminated by some other event or, the + * default, run the data once and stop. + * + * The vector source can also produce stream tags with the + * data. Pass in a vector of gr::tag_t objects and they will be + * emitted based on the specified offset of the tag. */ class BLOCKS_API @NAME@ : virtual public sync_block { |