diff options
| author | Tom Rondeau | 2012-04-22 11:04:12 -0400 |
|---|---|---|
| committer | Tom Rondeau | 2012-04-23 19:56:40 -0400 |
| commit | 1723a717658ce7a8729528706f2b71f99dea14f5 (patch) | |
| tree | 9a93935db14536b75835a0f111d7af184b1e76c0 /gr-digital/include/digital_simple_framer.h | |
| parent | 362d45bb829a9b190586cca79717cc175f4d06d2 (diff) | |
| download | gnuradio-1723a717658ce7a8729528706f2b71f99dea14f5.tar.gz gnuradio-1723a717658ce7a8729528706f2b71f99dea14f5.tar.bz2 gnuradio-1723a717658ce7a8729528706f2b71f99dea14f5.zip | |
docs: adding documentation for new gr-digital blocks.
Diffstat (limited to 'gr-digital/include/digital_simple_framer.h')
| -rw-r--r-- | gr-digital/include/digital_simple_framer.h | 6 |
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 5dcab05cb..b622ae5dd 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 { |