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/clock_recovery_mm_cc.h | |
| parent | 3757197293ef59fe08caa9f391f9e77f072ea19f (diff) | |
digital: fixed up documentation and default values of digital blocks.
Diffstat (limited to 'gr-digital/include/digital/clock_recovery_mm_cc.h')
| -rw-r--r-- | gr-digital/include/digital/clock_recovery_mm_cc.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/gr-digital/include/digital/clock_recovery_mm_cc.h b/gr-digital/include/digital/clock_recovery_mm_cc.h index 61499988d5..ec121c0fdf 100644 --- a/gr-digital/include/digital/clock_recovery_mm_cc.h +++ b/gr-digital/include/digital/clock_recovery_mm_cc.h @@ -50,9 +50,18 @@ namespace gr { // gr::digital::clock_recovery_mm_cc::sptr typedef boost::shared_ptr<clock_recovery_mm_cc> sptr; + /*! + * Make a M&M clock recovery block. + * + * \param omega Initial estimate of samples per symbol + * \param gain_omega Gain setting for omega update loop + * \param mu Initial estimate of phase of sample + * \param gain_mu Gain setting for mu update loop + * \param omega_relative_limit limit on omega + */ static sptr make(float omega, float gain_omega, float mu, float gain_mu, - float omega_relative_limi); + float omega_relative_limit); virtual float mu() const = 0; virtual float omega() const = 0; |