summaryrefslogtreecommitdiff
path: root/gr-digital/include/digital/packet_headerparser_b.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-digital/include/digital/packet_headerparser_b.h')
-rw-r--r--gr-digital/include/digital/packet_headerparser_b.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/gr-digital/include/digital/packet_headerparser_b.h b/gr-digital/include/digital/packet_headerparser_b.h
index a3db069cbd..2dc6a80717 100644
--- a/gr-digital/include/digital/packet_headerparser_b.h
+++ b/gr-digital/include/digital/packet_headerparser_b.h
@@ -35,7 +35,11 @@ namespace gr {
*
* 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 message.
+ * 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.
*
* If only a header length is given, this block uses the default header
* format.