summaryrefslogtreecommitdiff
path: root/gr-digital/include/digital
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2013-04-01 12:33:33 -0400
committerTom Rondeau <trondeau@vt.edu>2013-04-01 12:33:33 -0400
commit6834e1d4a23ee8b2b6f3fb449c515e6a99d781cd (patch)
tree6cdebd007d661040f4830817b2f535fd417ef571 /gr-digital/include/digital
parent7e1310eec954597d2e355f601780accc4985146e (diff)
parent5438517719dcac700915c7a515e5f5fe4104a3c5 (diff)
Merge remote-tracking branch 'mbant/taggedstreamdox'
Diffstat (limited to 'gr-digital/include/digital')
-rw-r--r--gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h2
-rw-r--r--gr-digital/include/digital/packet_header_default.h18
-rw-r--r--gr-digital/include/digital/packet_header_ofdm.h7
3 files changed, 20 insertions, 7 deletions
diff --git a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
index d5d526ddc3..321c58473d 100644
--- a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
+++ b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
@@ -43,7 +43,7 @@ namespace gr {
public:
typedef boost::shared_ptr<ofdm_frame_equalizer_vcvc> sptr;
- /*
+ /*!
* \param equalizer The equalizer object that will do the actual work
* \param len_tag_key Length tag key
* \param propagate_channel_state If true, the channel state after the last symbol
diff --git a/gr-digital/include/digital/packet_header_default.h b/gr-digital/include/digital/packet_header_default.h
index a4158e728c..d69a0f30a6 100644
--- a/gr-digital/include/digital/packet_header_default.h
+++ b/gr-digital/include/digital/packet_header_default.h
@@ -30,9 +30,19 @@ namespace gr {
namespace digital {
/*!
- * \brief <+description of block+>
+ * \brief Default header formatter for digital packet transmission.
* \ingroup digital
*
+ * For bursty/packetized digital transmission, packets are usually prepended
+ * with a packet header, containing the number of bytes etc.
+ * This class is not a block, but a tool to create these packet header.
+ *
+ * This is a default packet header (see header_formatter()) for a description
+ * on the header format). To create other header, derive packet header creator
+ * classes from this function.
+ *
+ * gr::digital::packet_headergenerator_bb uses header generators derived from
+ * this class to create packet headers from data streams.
*/
class DIGITAL_API packet_header_default : public boost::enable_shared_from_this<gr::digital::packet_header_default>
{
@@ -53,7 +63,8 @@ namespace gr {
long header_len() { return d_header_len; };
pmt::pmt_t len_tag_key() { return d_len_tag_key; };
- /* \brief Encodes the header information in the given tags into bits and places them into \p out
+ /*!
+ * \brief Encodes the header information in the given tags into bits and places them into \p out
*
* Uses the following header format:
* Bits 0-11: The packet length (what was stored in the tag with key \p len_tag_key)
@@ -70,7 +81,8 @@ namespace gr {
const std::vector<gr_tag_t> &tags=std::vector<gr_tag_t>()
);
- /* \brief Inverse function to header_formatter().
+ /*!
+ * \brief Inverse function to header_formatter().
*
* Reads the bit stream in \in and writes a corresponding tag into \p tags.
*
diff --git a/gr-digital/include/digital/packet_header_ofdm.h b/gr-digital/include/digital/packet_header_ofdm.h
index 6c3453ed1d..9f70900b49 100644
--- a/gr-digital/include/digital/packet_header_ofdm.h
+++ b/gr-digital/include/digital/packet_header_ofdm.h
@@ -48,7 +48,8 @@ namespace gr {
int bits_per_sym=1);
~packet_header_ofdm();
- /* \brief Inverse function to header_formatter().
+ /*!
+ * \brief Inverse function to header_formatter().
*
* Does the same as packet_header_default::header_parser(), but
* adds another tag that stores the number of OFDM symbols in the
@@ -72,8 +73,8 @@ namespace gr {
protected:
pmt::pmt_t d_frame_len_tag_key;
- const std::vector<std::vector<int> > d_occupied_carriers; //! Which carriers/symbols carry data
- int d_syms_per_set; //! Helper variable: Total number of elements in d_occupied_carriers
+ const std::vector<std::vector<int> > d_occupied_carriers; //!< Which carriers/symbols carry data
+ int d_syms_per_set; //!< Helper variable: Total number of elements in d_occupied_carriers
};
} // namespace digital