diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-03-13 23:03:15 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-03-13 23:03:15 -0400 |
| commit | 3e7d338c626a94b9073db3c57b90ab5d9f35b7f4 (patch) | |
| tree | 405a248bcdb0ecc781d55334239aaa0b2317cdb9 /gr-analog/include/analog/ctcss_squelch_ff.h | |
| parent | 9616494c07b86b8b76c3c49c66fe9dfa037989e7 (diff) | |
analog: added some documentation for a number of blocks.
Diffstat (limited to 'gr-analog/include/analog/ctcss_squelch_ff.h')
| -rw-r--r-- | gr-analog/include/analog/ctcss_squelch_ff.h | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/gr-analog/include/analog/ctcss_squelch_ff.h b/gr-analog/include/analog/ctcss_squelch_ff.h index f880299173..b63876714d 100644 --- a/gr-analog/include/analog/ctcss_squelch_ff.h +++ b/gr-analog/include/analog/ctcss_squelch_ff.h @@ -31,7 +31,7 @@ namespace gr { namespace analog { /*! - * \brief gate or zero output if ctcss tone not present + * \brief gate or zero output if CTCSS tone not present * \ingroup level_blk */ class ANALOG_API ctcss_squelch_ff : @@ -47,6 +47,14 @@ namespace gr { /*! * \brief Make CTCSS tone squelch block. + * + * \param rate gain of the internal frequency filters. + * \param freq frequency value to use as the squelch tone. + * \param level threshold level for the squelch tone. + * \param len length of the frequency filters. + * \param ramp sets response characteristic. + * \param gate if true, no output if no squelch tone. + * if false, output 0's if no squelch tone. */ static sptr make(int rate, float freq, float level, int len, int ramp, bool gate); |