[Commit-gnuradio] [gnuradio] 14/23: docs: adding docs for blocks::copy and digital::constellation_receiver to describe their message ports.

[git]

This is an automated email from the git hooks/post-receive script.

trondeau pushed a commit to branch master
in repository gnuradio.

commit f489c3c6afb7665e01ece94ff2b2121df041e614
Author: Tom Rondeau <address@hidden>
Date:   Thu Jun 26 14:03:37 2014 -0400

    docs: adding docs for blocks::copy and digital::constellation_receiver to 
describe their message ports.
---
 gr-blocks/include/gnuradio/blocks/copy.h                   |  6 ++++++
 .../include/gnuradio/digital/constellation_receiver_cb.h   | 14 +++++++++++++-
 2 files changed, 19 insertions(+), 1 deletion(-)

diff --git a/gr-blocks/include/gnuradio/blocks/copy.h 
b/gr-blocks/include/gnuradio/blocks/copy.h
index 151ab09..a953b41 100644
--- a/gr-blocks/include/gnuradio/blocks/copy.h
+++ b/gr-blocks/include/gnuradio/blocks/copy.h
@@ -36,6 +36,12 @@ namespace gr {
      * \details
      * When enabled (default), this block copies its input to its
      * output. When disabled, this block drops its input on the floor.
+     *
+     * Message Ports:
+     *
+     * - en (input):
+     *      Receives a PMT bool message to either enable to disable
+     *      copy.
      */
     class BLOCKS_API copy : virtual public block
     {
diff --git a/gr-digital/include/gnuradio/digital/constellation_receiver_cb.h 
b/gr-digital/include/gnuradio/digital/constellation_receiver_cb.h
index b380ba6..36cfd57 100644
--- a/gr-digital/include/gnuradio/digital/constellation_receiver_cb.h
+++ b/gr-digital/include/gnuradio/digital/constellation_receiver_cb.h
@@ -41,6 +41,18 @@ namespace gr {
      * loop that finds the error of the incoming signal point compared
      * to its nearest constellation point. The frequency and phase of
      * the NCO are updated according to this error.
+     *
+     * Message Ports:
+     *
+     * set_constellation (input):
+     *    Receives a PMT any containing a new gr::digital::constellation 
object.
+     *    The PMT is cast back to a gr::digital::constellation_sptr
+     *    and passes this to set_constellation.
+     *
+     * rotate_phase (input):
+     *    Receives a PMT double to update the phase.
+     *    The phase value passed in the message is added to the
+     *    current phase of the receiver.
      */
     class DIGITAL_API constellation_receiver_cb
       : virtual public block
@@ -59,7 +71,7 @@ namespace gr {
        * \param fmin          minimum normalized frequency value the loop can 
achieve
        * \param fmax          maximum normalized frequency value the loop can 
achieve
        */
-      static sptr make(constellation_sptr constellation, 
+      static sptr make(constellation_sptr constellation,
                       float loop_bw, float fmin, float fmax);
 
       virtual void phase_error_tracking(float phase_error) = 0;