summaryrefslogtreecommitdiff
path: root/gr-digital/include/digital
diff options
context:
space:
mode:
Diffstat (limited to 'gr-digital/include/digital')
-rw-r--r--gr-digital/include/digital/header_payload_demux.h3
-rw-r--r--gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h2
-rw-r--r--gr-digital/include/digital/packet_header_default.h3
-rw-r--r--gr-digital/include/digital/packet_headergenerator_bb.h3
-rw-r--r--gr-digital/include/digital/packet_headerparser_b.h4
5 files changed, 10 insertions, 5 deletions
diff --git a/gr-digital/include/digital/header_payload_demux.h b/gr-digital/include/digital/header_payload_demux.h
index 014e0304a2..1427062d77 100644
--- a/gr-digital/include/digital/header_payload_demux.h
+++ b/gr-digital/include/digital/header_payload_demux.h
@@ -30,8 +30,9 @@ namespace gr {
/*!
* \brief Header/Payload demuxer.
- * \ingroup digital
+ * \ingroup packet_operators_blk
*
+ * \details
* This block is designed to handle packets from a bursty transmission.
* Input 0 takes a continuous transmission of samples.
* If used, input 1 is a trigger signal. In this case, a 1 on input 1
diff --git a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
index de74d325ad..97c9877f85 100644
--- a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
+++ b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h
@@ -31,7 +31,7 @@ namespace gr {
/*!
* \brief OFDM frame equalizer
- * \ingroup ofdm
+ * \ingroup ofdm_blk
*
* Performs equalization in one or two dimensions on a tagged OFDM frame.
* Input: a tagged series of OFDM symbols.
diff --git a/gr-digital/include/digital/packet_header_default.h b/gr-digital/include/digital/packet_header_default.h
index f97b1a4c81..64804e6d6a 100644
--- a/gr-digital/include/digital/packet_header_default.h
+++ b/gr-digital/include/digital/packet_header_default.h
@@ -31,8 +31,9 @@ namespace gr {
/*!
* \brief Default header formatter for digital packet transmission.
- * \ingroup digital
+ * \ingroup packet_operators_blk
*
+ * \details
* 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.
diff --git a/gr-digital/include/digital/packet_headergenerator_bb.h b/gr-digital/include/digital/packet_headergenerator_bb.h
index cec860fd55..426f49dee5 100644
--- a/gr-digital/include/digital/packet_headergenerator_bb.h
+++ b/gr-digital/include/digital/packet_headergenerator_bb.h
@@ -31,8 +31,9 @@ namespace gr {
/*!
* \brief Generates a header for a tagged, streamed packet.
- * \ingroup digital
+ * \ingroup packet_operators_blk
*
+ * \details
* Input: A tagged stream. This is consumed entirely, it is not appended
* to the output stream.
* Output: An tagged stream containing the header. The details on the header
diff --git a/gr-digital/include/digital/packet_headerparser_b.h b/gr-digital/include/digital/packet_headerparser_b.h
index 2dc6a80717..cdf76f1209 100644
--- a/gr-digital/include/digital/packet_headerparser_b.h
+++ b/gr-digital/include/digital/packet_headerparser_b.h
@@ -31,12 +31,14 @@ namespace gr {
/*!
* \brief Post header metadata as a PMT
- * \ingroup digital
+ * \ingroup packet_operators_blk
*
+ * \details
* In a sense, this is the inverse block to packet_headergenerator_bb.
* The difference is, the parsed header is not output as a stream,
* but as a PMT dictionary, which is published to message port with
* the id "header_data".
+ *
* The dictionary consists of the tags created by the header formatter
* object. You should be able to use the exact same formatter object
* as used on the Tx side in the packet_headergenerator_bb.