From: trondeau <trondeau@221aa14e-8319-0410-a670-987f0aec2ac5>
Date: Fri, 15 Dec 2006 00:59:53 +0000 (+0000)
Subject: more expressive Doxygen tag for using Costas loop
X-Git-Url: https://git.gag.com/?a=commitdiff_plain;h=6b34a29b1370d59b5c32fa6b4bb1e5639b8619b8;p=debian%2Fgnuradio

more expressive Doxygen tag for using Costas loop

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@4093 221aa14e-8319-0410-a670-987f0aec2ac5
---

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 d7d0db67..caa15849 100644
--- a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
+++ b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
@@ -41,6 +41,9 @@ gr_make_costas_loop_cc (float alpha, float beta,
 /*!
  * \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.
  */