diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2012-04-22 11:04:12 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2012-04-23 19:56:40 -0400 |
| commit | 1723a717658ce7a8729528706f2b71f99dea14f5 (patch) | |
| tree | 9a93935db14536b75835a0f111d7af184b1e76c0 /gr-digital/include/digital_glfsr_source_b.h | |
| parent | 362d45bb829a9b190586cca79717cc175f4d06d2 (diff) | |
docs: adding documentation for new gr-digital blocks.
Diffstat (limited to 'gr-digital/include/digital_glfsr_source_b.h')
| -rw-r--r-- | gr-digital/include/digital_glfsr_source_b.h | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/gr-digital/include/digital_glfsr_source_b.h b/gr-digital/include/digital_glfsr_source_b.h index 3cc570d3d3..92e5e81f5c 100644 --- a/gr-digital/include/digital_glfsr_source_b.h +++ b/gr-digital/include/digital_glfsr_source_b.h @@ -38,6 +38,14 @@ digital_make_glfsr_source_b(int degree, bool repeat=true, /*! * \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 digital_glfsr_source_b : public gr_sync_block { |