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/glfsr_source_b.h | |
| parent | 3757197293ef59fe08caa9f391f9e77f072ea19f (diff) | |
digital: fixed up documentation and default values of digital blocks.
Diffstat (limited to 'gr-digital/include/digital/glfsr_source_b.h')
| -rw-r--r-- | gr-digital/include/digital/glfsr_source_b.h | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/gr-digital/include/digital/glfsr_source_b.h b/gr-digital/include/digital/glfsr_source_b.h index 8edabc836f..9e245875d4 100644 --- a/gr-digital/include/digital/glfsr_source_b.h +++ b/gr-digital/include/digital/glfsr_source_b.h @@ -32,14 +32,6 @@ namespace gr { /*! * \brief Galois LFSR pseudo-random source * \ingroup source_blk - * - * \param degree Degree of shift register must be in [1, 32]. If mask - * is 0, the degree determines a default mask (see - * digital_impl_glfsr.cc for the mapping). - * \param repeat Set to repeat sequence. - * \param mask Allows a user-defined bit mask for indexes of the shift - * register to feed back. - * \param seed Initial setting for values in shift register. */ class DIGITAL_API glfsr_source_b : virtual public gr_sync_block { @@ -47,6 +39,17 @@ namespace gr { // gr::digital::glfsr_source_b::sptr typedef boost::shared_ptr<glfsr_source_b> sptr; + /*! + * Make a Galois LFSR pseudo-random source block. + * + * \param degree Degree of shift register must be in [1, 32]. If mask + * is 0, the degree determines a default mask (see + * digital_impl_glfsr.cc for the mapping). + * \param repeat Set to repeat sequence. + * \param mask Allows a user-defined bit mask for indexes of the shift + * register to feed back. + * \param seed Initial setting for values in shift register. + */ static sptr make(int degree, bool repeat=true, int mask=0, int seed=1); |