From 71193898cbd7a26ec7bde00ee5efdc77242a155f Mon Sep 17 00:00:00 2001 From: trondeau Date: Tue, 24 Apr 2007 21:09:59 +0000 Subject: [PATCH] update to Doxygen info to fix warning and a bit more explicit info on frequency ranges git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@5095 221aa14e-8319-0410-a670-987f0aec2ac5 --- gnuradio-core/src/lib/general/gr_costas_loop_cc.h | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h index 501d3459..0fe798c8 100644 --- a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h +++ b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h @@ -50,9 +50,8 @@ typedef boost::shared_ptr gr_costas_loop_cc_sptr; * * \param alpha the loop gain used for phase adjustment * \param beta the loop gain for frequency adjustments - * \param max_freq the maximum frequency deviation the loop can handle - * \param min_freq the minimum frequency deviation the loop can - * handle + * \param max_freq the maximum frequency deviation (normalized frequency) the loop can handle + * \param min_freq the minimum frequency deviation (normalized frequency) the loop can handle * \param order the loop order, either 2 or 4 */ gr_costas_loop_cc_sptr @@ -87,8 +86,8 @@ class gr_costas_loop_cc : public gr_sync_block int order ) throw (std::invalid_argument); - /*! \breif the phase detector circuit for fourth-order loops - * \param a complex sample + /*! \brief the phase detector circuit for fourth-order loops + * \param sample complex sample * \return the phase error */ float phase_detector_4(gr_complex sample) const; // for QPSK -- 2.30.2