summaryrefslogtreecommitdiff
path: root/gr-digital/include/digital_diff_phasor_cc.h
diff options
context:
space:
mode:
authorTom Rondeau <trondeau@vt.edu>2012-04-22 11:04:12 -0400
committerTom Rondeau <trondeau@vt.edu>2012-04-23 19:56:40 -0400
commit1723a717658ce7a8729528706f2b71f99dea14f5 (patch)
tree9a93935db14536b75835a0f111d7af184b1e76c0 /gr-digital/include/digital_diff_phasor_cc.h
parent362d45bb829a9b190586cca79717cc175f4d06d2 (diff)
docs: adding documentation for new gr-digital blocks.
Diffstat (limited to 'gr-digital/include/digital_diff_phasor_cc.h')
-rw-r--r--gr-digital/include/digital_diff_phasor_cc.h9
1 files changed, 7 insertions, 2 deletions
diff --git a/gr-digital/include/digital_diff_phasor_cc.h b/gr-digital/include/digital_diff_phasor_cc.h
index b6e1a2afba..32a2464b28 100644
--- a/gr-digital/include/digital_diff_phasor_cc.h
+++ b/gr-digital/include/digital_diff_phasor_cc.h
@@ -27,8 +27,13 @@
#include <gr_sync_block.h>
/*!
- * \brief Please fix my documentation!
- * \ingroup misc
+ * \brief Differential decoding based on phase change.
+ * \ingroup coding_blk
+ *
+ * Uses the phase difference between two symbols to determine the
+ * output symbol:
+ *
+ * out[i] = in[i] * conj(in[i-1]);
*/
class digital_diff_phasor_cc;
typedef boost::shared_ptr<digital_diff_phasor_cc> digital_diff_phasor_cc_sptr;