summaryrefslogtreecommitdiff
path: root/gr-digital/include/digital_simple_framer.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-digital/include/digital_simple_framer.h')
-rw-r--r--gr-digital/include/digital_simple_framer.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/gr-digital/include/digital_simple_framer.h b/gr-digital/include/digital_simple_framer.h
index 5dcab05cb3..b622ae5dd4 100644
--- a/gr-digital/include/digital_simple_framer.h
+++ b/gr-digital/include/digital_simple_framer.h
@@ -34,6 +34,12 @@ DIGITAL_API digital_simple_framer_sptr digital_make_simple_framer(int payload_by
/*!
* \brief add sync field, seq number and command field to payload
* \ingroup sync_blk
+ *
+ * Takes in enough samples to create a full output frame. The frame is
+ * prepended with the GRSF_SYNC (defind in
+ * digital_simple_framer_sync.h) and an 8-bit sequence number.
+ *
+ * \param payload_bytesize The size of the payload in bytes.
*/
class DIGITAL_API digital_simple_framer : public gr_block
{