summaryrefslogtreecommitdiff
path: root/gnuradio-core/src/lib
diff options
context:
space:
mode:
authortrondeau2006-12-15 00:59:53 +0000
committertrondeau2006-12-15 00:59:53 +0000
commit6b34a29b1370d59b5c32fa6b4bb1e5639b8619b8 (patch)
treef4ce5e7e9aacac3f4d68e345ec32c32799d7fb90 /gnuradio-core/src/lib
parent3ffcee6b999a5ec8a1e59c0a26cd8f3bc7725dfc (diff)
downloadgnuradio-6b34a29b1370d59b5c32fa6b4bb1e5639b8619b8.tar.gz
gnuradio-6b34a29b1370d59b5c32fa6b4bb1e5639b8619b8.tar.bz2
gnuradio-6b34a29b1370d59b5c32fa6b4bb1e5639b8619b8.zip
more expressive Doxygen tag for using Costas loop
git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@4093 221aa14e-8319-0410-a670-987f0aec2ac5
Diffstat (limited to 'gnuradio-core/src/lib')
-rw-r--r--gnuradio-core/src/lib/general/gr_costas_loop_cc.h3
1 files changed, 3 insertions, 0 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 d7d0db67b..caa158498 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.
*/