diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2010-11-21 20:51:37 -0500 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2010-11-21 20:51:37 -0500 |
| commit | 1b7b68ec2211c50de98bef7414e4ac807edf460a (patch) | |
| tree | f923ed049928fe4746b00db92767a4c59d0ce72b | |
| parent | 7ecc767e8fe6248d5e9372da8c7cfb9aacbd790b (diff) | |
Doxygen comments. Fixing typos that were leading to warnings.
| -rw-r--r-- | gnuradio-core/src/lib/runtime/gr_block.h | 2 | ||||
| -rw-r--r-- | gnuradio-core/src/lib/runtime/gr_block_detail.h | 2 | ||||
| -rw-r--r-- | gnuradio-core/src/lib/runtime/gr_buffer.h | 6 |
3 files changed, 8 insertions, 2 deletions
diff --git a/gnuradio-core/src/lib/runtime/gr_block.h b/gnuradio-core/src/lib/runtime/gr_block.h index 7caf3c34a2..36eed3d106 100644 --- a/gnuradio-core/src/lib/runtime/gr_block.h +++ b/gnuradio-core/src/lib/runtime/gr_block.h @@ -247,7 +247,7 @@ class gr_block : public gr_basic_block { /*! * \brief Adds a new tag onto the given output buffer. * - * \param which_ouput an integer of which output stream to attach the tag + * \param which_output an integer of which output stream to attach the tag * \param abs_offset a uint64 number of the absolute item number * assicated with the tag. Can get from nitems_written. * \param key the tag key as a PMT symbol diff --git a/gnuradio-core/src/lib/runtime/gr_block_detail.h b/gnuradio-core/src/lib/runtime/gr_block_detail.h index 834ef47f5f..d7ec3b1368 100644 --- a/gnuradio-core/src/lib/runtime/gr_block_detail.h +++ b/gnuradio-core/src/lib/runtime/gr_block_detail.h @@ -103,7 +103,7 @@ class gr_block_detail { * from it. It then calls gr_buffer::add_item_tag(pmt::pmt_t t), * which appends the tag onto its deque. * - * \param which_ouput an integer of which output stream to attach the tag + * \param which_output an integer of which output stream to attach the tag * \param abs_offset a uint64 number of the absolute item number * assicated with the tag. Can get from nitems_written. * \param key the tag key as a PMT symbol diff --git a/gnuradio-core/src/lib/runtime/gr_buffer.h b/gnuradio-core/src/lib/runtime/gr_buffer.h index 2d88c17227..fe0e7585dc 100644 --- a/gnuradio-core/src/lib/runtime/gr_buffer.h +++ b/gnuradio-core/src/lib/runtime/gr_buffer.h @@ -99,6 +99,11 @@ class gr_buffer { */ void add_item_tag(const pmt::pmt_t &tag); + /*! + * \brief Removes all tags before \p max_time from buffer + * + * \param max_time the time (item number) to trim up until. + */ void prune_tags(uint64_t max_time); std::deque<pmt::pmt_t>::iterator get_tags_begin() { return d_item_tags.begin(); } @@ -244,6 +249,7 @@ class gr_buffer_reader { /*! * \brief Return the block that reads via this reader. + * */ gr_block_sptr link() { return gr_block_sptr(d_link); } |