diff options
| author | Tom Rondeau | 2011-12-30 11:24:12 -0500 |
|---|---|---|
| committer | Tom Rondeau | 2011-12-30 11:24:12 -0500 |
| commit | 8e134f11639deeadd0ed242e0f12360ef628d495 (patch) | |
| tree | b87775c0b22122a1de69283a1cd088836f16b793 /gr-digital | |
| parent | ef4d48de26b64d89851a93fc5402b33fcc1a809f (diff) | |
| download | gnuradio-8e134f11639deeadd0ed242e0f12360ef628d495.tar.gz gnuradio-8e134f11639deeadd0ed242e0f12360ef628d495.tar.bz2 gnuradio-8e134f11639deeadd0ed242e0f12360ef628d495.zip | |
digital: fixed documentation of parameters.
Diffstat (limited to 'gr-digital')
| -rw-r--r-- | gr-digital/include/digital_impl_mpsk_snr_est.h | 16 | ||||
| -rw-r--r-- | gr-digital/include/digital_mpsk_snr_est_cc.h | 6 |
2 files changed, 11 insertions, 11 deletions
diff --git a/gr-digital/include/digital_impl_mpsk_snr_est.h b/gr-digital/include/digital_impl_mpsk_snr_est.h index cae95da09..df7dbadec 100644 --- a/gr-digital/include/digital_impl_mpsk_snr_est.h +++ b/gr-digital/include/digital_impl_mpsk_snr_est.h @@ -58,7 +58,7 @@ class DIGITAL_API digital_impl_mpsk_snr_est /*! Constructor * * Parameters: - * \li \p alpha: the update rate of internal running average + * \param alpha: the update rate of internal running average * calculations. */ digital_impl_mpsk_snr_est(double alpha); @@ -97,7 +97,7 @@ class DIGITAL_API digital_impl_mpsk_snr_est_simple : /*! Constructor * * Parameters: - * \li \p alpha: the update rate of internal running average + * \param alpha: the update rate of internal running average * calculations. */ digital_impl_mpsk_snr_est_simple(double alpha); @@ -129,7 +129,7 @@ class DIGITAL_API digital_impl_mpsk_snr_est_skew : /*! Constructor * * Parameters: - * \li \p alpha: the update rate of internal running average + * \param alpha: the update rate of internal running average * calculations. */ digital_impl_mpsk_snr_est_skew(double alpha); @@ -167,7 +167,7 @@ class DIGITAL_API digital_impl_mpsk_snr_est_m2m4 : /*! Constructor * * Parameters: - * \li \p alpha: the update rate of internal running average + * \param alpha: the update rate of internal running average * calculations. */ digital_impl_mpsk_snr_est_m2m4(double alpha); @@ -220,10 +220,10 @@ class DIGITAL_API digital_impl_snr_est_m2m4 : /*! Constructor * * Parameters: - * \li \p alpha: the update rate of internal running average + * \param alpha: the update rate of internal running average * calculations. - * \li \p ka: estimate of the signal kurtosis (1 for PSK) - * \li \p kw: estimate of the channel noise kurtosis (2 for AWGN) + * \param ka: estimate of the signal kurtosis (1 for PSK) + * \param kw: estimate of the channel noise kurtosis (2 for AWGN) */ digital_impl_snr_est_m2m4(double alpha, double ka, double kw); ~digital_impl_snr_est_m2m4() {} @@ -265,7 +265,7 @@ class DIGITAL_API digital_impl_mpsk_snr_est_svr : /*! Constructor * * Parameters: - * \li \p alpha: the update rate of internal running average + * \param alpha: the update rate of internal running average * calculations. */ digital_impl_mpsk_snr_est_svr(double alpha); diff --git a/gr-digital/include/digital_mpsk_snr_est_cc.h b/gr-digital/include/digital_mpsk_snr_est_cc.h index 40c790222..2cbd98bab 100644 --- a/gr-digital/include/digital_mpsk_snr_est_cc.h +++ b/gr-digital/include/digital_mpsk_snr_est_cc.h @@ -65,11 +65,11 @@ class DIGITAL_API digital_mpsk_snr_est_cc : public gr_sync_block * * Parameters: * - * \li \p type: the type of estimator to use \ref ref_snr_est_types + * \param type: the type of estimator to use \ref ref_snr_est_types * "snr_est_type_t" for details about the available types. - * \li \p tag_nsamples: after this many samples, a tag containing + * \param tag_nsamples: after this many samples, a tag containing * the SNR (key='snr') will be sent - * \li \p alpha: the update rate of internal running average + * \param alpha: the update rate of internal running average * calculations. */ friend DIGITAL_API digital_mpsk_snr_est_cc_sptr |