summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2013-05-07 19:25:11 -0400
committerTom Rondeau <trondeau@vt.edu>2013-05-07 19:26:15 -0400
commit4c4c0d165124c5d4997f139d50cb9729c87b92b9 (patch)
treeeace716bcb5242489cb53283675998724a2ed861
parente5612be51e40a02cf948786c51166a584b1ff8f6 (diff)
docs: fixed warnings.
-rw-r--r--gnuradio-core/src/lib/runtime/gr_buffer.h2
-rw-r--r--gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h2
-rw-r--r--gr-digital/include/digital/packet_header_ofdm.h1
3 files changed, 5 insertions, 0 deletions
diff --git a/gnuradio-core/src/lib/runtime/gr_buffer.h b/gnuradio-core/src/lib/runtime/gr_buffer.h
index 443ffb3906..399ec567f1 100644
--- a/gnuradio-core/src/lib/runtime/gr_buffer.h
+++ b/gnuradio-core/src/lib/runtime/gr_buffer.h
@@ -112,6 +112,7 @@ class GR_CORE_API gr_buffer {
* the tag.
*
* \param tag the tag that needs to be removed
+ * \param id an ID for this tag so other blocks can check it.
*/
void remove_item_tag(const gr_tag_t &tag, long id);
@@ -283,6 +284,7 @@ class GR_CORE_API gr_buffer_reader {
* \param v a vector reference to return tags into
* \param abs_start a uint64 count of the start of the range of interest
* \param abs_end a uint64 count of the end of the range of interest
+ * \param id an ID to check if its been removed.
*/
void get_tags_in_range(std::vector<gr_tag_t> &v,
uint64_t abs_start,
diff --git a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
index 23f3041e27..262a9b4302 100644
--- a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
+++ b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
@@ -48,6 +48,8 @@ namespace gr {
* \param len_tag_key Length tag key
* \param propagate_channel_state If true, the channel state after the last symbol
* will be added to the first symbol as a tag
+ * \param fixed_frame_len Set if the frame length is fixed throughout,
+ * helps with book keeping.
*/
static sptr make(
digital_ofdm_equalizer_base_sptr equalizer,
diff --git a/gr-digital/include/digital/packet_header_ofdm.h b/gr-digital/include/digital/packet_header_ofdm.h
index de4f0a5000..ea55a4510a 100644
--- a/gr-digital/include/digital/packet_header_ofdm.h
+++ b/gr-digital/include/digital/packet_header_ofdm.h
@@ -70,6 +70,7 @@ namespace gr {
* \param frame_len_tag_key The tag key used for the frame length (number of
* OFDM symbols, this is the tag key required for the
* frame equalizer etc.)
+ * \param num_tag_key The tag key used for packet numbering.
* \param bits_per_header_sym Bits per complex symbol in the header, e.g. 1 if
* the header is BPSK modulated, 2 if it's QPSK
* modulated etc.