[Commit-gnuradio] r5217 - gnuradio/branches/features/inband-usb/mblock/src/lib

[eb]

Author: eb
Date: 2007-05-01 21:13:59 -0600 (Tue, 01 May 2007)
New Revision: 5217

Modified:
   gnuradio/branches/features/inband-usb/mblock/src/lib/qa_bitset.cc
   gnuradio/branches/features/inband-usb/mblock/src/lib/qa_timeouts.cc
Log:
documentation

Modified: gnuradio/branches/features/inband-usb/mblock/src/lib/qa_bitset.cc
===================================================================
--- gnuradio/branches/features/inband-usb/mblock/src/lib/qa_bitset.cc   
2007-05-02 02:54:30 UTC (rev 5216)
+++ gnuradio/branches/features/inband-usb/mblock/src/lib/qa_bitset.cc   
2007-05-02 03:13:59 UTC (rev 5217)
@@ -45,6 +45,20 @@
   return s.str();
 }
 
+/*!
+ * \brief mblock used for QA.
+ *
+ * Messages arriving on "in" consist of a pair containing a (long)
+ * message number in the car, and a (long) bitmap in the cdr.  For
+ * each message received on "in", a new message is sent on "out".  The
+ * new message is the same format as the input, but the bitmap in
+ * the cdr has a "1" or'd into it that corresponds to the bit number
+ * specified in the constructor.
+ *
+ * The bitmap can be used by the ultimate receiver to confirm
+ * traversal of a set of blocks, if the blocks are assigned unique bit
+ * numbers.
+ */
 class qa_bitset : public mb_mblock
 {
   mb_port_sptr d_in;
@@ -69,8 +83,9 @@
 qa_bitset::handle_message(mb_message_sptr msg)
 {
   if (pmt_eq(msg->port_id(), s_in) && pmt_eq(msg->signal(), s_data)){
-    d_out->send(s_data, pmt_cons(pmt_car(msg->data()),
-                                pmt_from_long((1L << d_bitno) | 
pmt_to_long(pmt_cdr(msg->data())))));
+    d_out->send(s_data,
+               pmt_cons(pmt_car(msg->data()),
+                        pmt_from_long((1L << d_bitno) | 
pmt_to_long(pmt_cdr(msg->data())))));
   }
 }
 
@@ -78,6 +93,9 @@
 
 // ------------------------------------------------------------------------
 
+/*!
+ * \brief mblock used for QA.  Compose two qa_bitset mblocks.
+ */
 class qa_bitset2 : public mb_mblock
 {
   mb_port_sptr d_in;
@@ -106,6 +124,9 @@
 
 // ------------------------------------------------------------------------
 
+/*!
+ * \brief mblock used for QA.  Compose two qa_bitset2 mblocks.
+ */
 class qa_bitset4 : public mb_mblock
 {
   mb_port_sptr d_in;
@@ -134,6 +155,9 @@
 
 // ------------------------------------------------------------------------
 
+/*!
+ * \brief mblock used for QA.  Compose two qa_bitset4 mblocks.
+ */
 class qa_bitset8 : public mb_mblock
 {
   mb_port_sptr d_in;
@@ -162,6 +186,9 @@
 
 // ------------------------------------------------------------------------
 
+/*!
+ * \brief mblock used for QA.  Compose two qa_bitset8 mblocks.
+ */
 class qa_bitset16 : public mb_mblock
 {
   mb_port_sptr d_in;
@@ -190,6 +217,9 @@
 
 // ------------------------------------------------------------------------
 
+/*!
+ * \brief mblock used for QA.  Compose two qa_bitset16 mblocks.
+ */
 class qa_bitset32 : public mb_mblock
 {
   mb_port_sptr d_in;

Modified: gnuradio/branches/features/inband-usb/mblock/src/lib/qa_timeouts.cc
===================================================================
--- gnuradio/branches/features/inband-usb/mblock/src/lib/qa_timeouts.cc 
2007-05-02 02:54:30 UTC (rev 5216)
+++ gnuradio/branches/features/inband-usb/mblock/src/lib/qa_timeouts.cc 
2007-05-02 03:13:59 UTC (rev 5217)
@@ -44,7 +44,7 @@
 
 
 // ------------------------------------------------------------------------
-// This test exercises the priority queue that we use to implement timeouts
+//    Exercise the priority queue used to implement timeouts.
 // ------------------------------------------------------------------------
 void
 qa_timeouts::test_timer_queue()