diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2012-08-21 23:38:27 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2012-08-22 21:25:23 -0400 |
| commit | 695278bc00c8203389a917190563b0a22fea800d (patch) | |
| tree | 45573477ef0c38841f3edbad8487869182089cfc /gr-digital/include/digital/constellation_decoder_cb.h | |
| parent | 3757197293ef59fe08caa9f391f9e77f072ea19f (diff) | |
digital: fixed up documentation and default values of digital blocks.
Diffstat (limited to 'gr-digital/include/digital/constellation_decoder_cb.h')
| -rw-r--r-- | gr-digital/include/digital/constellation_decoder_cb.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/gr-digital/include/digital/constellation_decoder_cb.h b/gr-digital/include/digital/constellation_decoder_cb.h index 2a98cae643..01b35db905 100644 --- a/gr-digital/include/digital/constellation_decoder_cb.h +++ b/gr-digital/include/digital/constellation_decoder_cb.h @@ -35,6 +35,9 @@ namespace gr { * \ingroup coding_blk * \ingroup digital * + * Decode a constellation's points from a complex space to + * (unpacked) bits based on the map of the \p consetllation + * object. */ class DIGITAL_API constellation_decoder_cb : virtual public gr_block @@ -45,6 +48,10 @@ namespace gr { /*! * \brief Make constellation decoder block. + * + * \param constellation A constellation derived from class + * 'constellation'. Use base() method to get a shared pointer to + * this base class type. */ static sptr make(constellation_sptr constellation); }; |