diff options
| author | Tom Rondeau | 2011-10-09 17:10:12 -0400 |
|---|---|---|
| committer | Tom Rondeau | 2011-10-09 17:10:12 -0400 |
| commit | 2656ad175c70322902b960db5ac649c7bbfa0572 (patch) | |
| tree | bf7c5eb83fb9948be31d43fb86f69b3709449e27 /gr-vocoder/include | |
| parent | 34c8a8e591ec0dabe6e9bab0d65d3eae27ebb2db (diff) | |
| download | gnuradio-2656ad175c70322902b960db5ac649c7bbfa0572.tar.gz gnuradio-2656ad175c70322902b960db5ac649c7bbfa0572.tar.bz2 gnuradio-2656ad175c70322902b960db5ac649c7bbfa0572.zip | |
docs: adding README.vocoder and a Doxygen page for the vocoder block.
Diffstat (limited to 'gr-vocoder/include')
| -rw-r--r-- | gr-vocoder/include/vocoder_cvsd_decode_bs.h | 2 | ||||
| -rw-r--r-- | gr-vocoder/include/vocoder_cvsd_encode_sb.h | 8 |
2 files changed, 7 insertions, 3 deletions
diff --git a/gr-vocoder/include/vocoder_cvsd_decode_bs.h b/gr-vocoder/include/vocoder_cvsd_decode_bs.h index dd588c661..104ec2400 100644 --- a/gr-vocoder/include/vocoder_cvsd_decode_bs.h +++ b/gr-vocoder/include/vocoder_cvsd_decode_bs.h @@ -34,6 +34,8 @@ typedef boost::shared_ptr<vocoder_cvsd_decode_bs> vocoder_cvsd_decode_bs_sptr; * values are modeled after the Bluetooth standard and should not be changed, * except by an advanced user * + * \ingroup vocoder_blk + * * \param min_step Minimum step size used to update the internal reference. Default: "10" * \param max_step Maximum step size used to update the internal reference. Default: "1280" * \param step_decay Decay factor applied to step size when there is not a run of J output 1s or 0s. Default: "0.9990234375" (i.e. 1-1/1024) diff --git a/gr-vocoder/include/vocoder_cvsd_encode_sb.h b/gr-vocoder/include/vocoder_cvsd_encode_sb.h index da09b3927..422a2f521 100644 --- a/gr-vocoder/include/vocoder_cvsd_encode_sb.h +++ b/gr-vocoder/include/vocoder_cvsd_encode_sb.h @@ -29,9 +29,11 @@ class vocoder_cvsd_encode_sb; typedef boost::shared_ptr<vocoder_cvsd_encode_sb> vocoder_cvsd_encode_sb_sptr; /*! - * \brief Constructor parameters to initialize the CVSD encoder. The default - * values are modeled after the Bluetooth standard and should not be changed - * except by an advanced user + * \brief Constructor parameters to initialize the CVSD encoder. The + * default values are modeled after the Bluetooth standard and should + * not be changed except by an advanced user + * + * \ingroup vocoder_blk * * \param min_step Minimum step size used to update the internal reference. Default: "10" * \param max_step Maximum step size used to update the internal reference. Default: "1280" |