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

[trondeau]

Author: trondeau
Date: 2006-12-14 17:59:53 -0700 (Thu, 14 Dec 2006)
New Revision: 4093

Modified:
   gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
Log:
more expressive Doxygen tag for using Costas loop

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    
2006-12-15 00:06:05 UTC (rev 4092)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h    
2006-12-15 00:59:53 UTC (rev 4093)
@@ -41,6 +41,9 @@
 /*!
  * \brief Carrier tracking PLL for QPSK
  * input: complex; output: complex
+ * <br>The Costas loop can have two output streams:
+ *    stream 1 is the baseband I&Q;
+ *    stream 2 is the normalized frequency of the loop
  *
  * \p order must be 2 or 4.
  */