summaryrefslogtreecommitdiff
path: root/gr-digital/include/digital_glfsr_source_b.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-digital/include/digital_glfsr_source_b.h')
-rw-r--r--gr-digital/include/digital_glfsr_source_b.h8
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 3cc570d3d..92e5e81f5 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
{