summaryrefslogtreecommitdiff
path: root/gr-digital/include/digital_packet_sink.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-digital/include/digital_packet_sink.h')
-rw-r--r--gr-digital/include/digital_packet_sink.h14
1 files changed, 9 insertions, 5 deletions
diff --git a/gr-digital/include/digital_packet_sink.h b/gr-digital/include/digital_packet_sink.h
index 7ab41c0ef7..d9efa8f565 100644
--- a/gr-digital/include/digital_packet_sink.h
+++ b/gr-digital/include/digital_packet_sink.h
@@ -37,8 +37,9 @@ digital_make_packet_sink(const std::vector<unsigned char>& sync_vector,
/*!
* \brief process received bits looking for packet sync, header, and process bits into packet
- * \ingroup sink_blk
+ * \ingroup packet_operators_blk
*
+ * \details
* input: stream of symbols to be sliced.
*
* output: none. Pushes assembled packet into target queue
@@ -53,10 +54,6 @@ digital_make_packet_sink(const std::vector<unsigned char>& sync_vector,
* This block is not very useful anymore as it only works with 2-level
* modulations such as BPSK or GMSK. The block can generally be
* replaced with a correlate access code and frame sink blocks.
- *
- * \param sync_vector The synchronization vector as a vector of 1's and 0's.
- * \param target_queue The message queue that packets are sent to.
- * \param threshold Number of bits that can be incorrect in the \p sync_vector.
*/
class DIGITAL_API digital_packet_sink : public gr_sync_block
{
@@ -89,6 +86,13 @@ class DIGITAL_API digital_packet_sink : public gr_sync_block
int d_packetlen_cnt; // how many so far
protected:
+ /*!
+ * Build a packet sink block.
+ *
+ * \param sync_vector The synchronization vector as a vector of 1's and 0's.
+ * \param target_queue The message queue that packets are sent to.
+ * \param threshold Number of bits that can be incorrect in the \p sync_vector.
+ */
digital_packet_sink(const std::vector<unsigned char>& sync_vector,
gr_msg_queue_sptr target_queue,
int threshold);