[Commit-gnuradio] r5095 - gnuradio/trunk/gnuradio-core/src/lib/general

[trondeau]

Author: trondeau
Date: 2007-04-24 15:09:59 -0600 (Tue, 24 Apr 2007)
New Revision: 5095

Modified:
   gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
Log:
update to Doxygen info to fix warning and a bit more explicit info on frequency 
ranges

Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h    
2007-04-24 03:27:26 UTC (rev 5094)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h    
2007-04-24 21:09:59 UTC (rev 5095)
@@ -50,9 +50,8 @@
  *  
  * \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 @@
                     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