[Commit-gnuradio] r8649 - usrp2/branches/features/host-ng/host-ng/lib

[eb]

Author: eb
Date: 2008-06-21 15:39:21 -0600 (Sat, 21 Jun 2008)
New Revision: 8649

Modified:
   usrp2/branches/features/host-ng/host-ng/lib/eth_buffer.h
Log:
doc fix

Modified: usrp2/branches/features/host-ng/host-ng/lib/eth_buffer.h
===================================================================
--- usrp2/branches/features/host-ng/host-ng/lib/eth_buffer.h    2008-06-21 
21:33:24 UTC (rev 8648)
+++ usrp2/branches/features/host-ng/host-ng/lib/eth_buffer.h    2008-06-21 
21:39:21 UTC (rev 8649)
@@ -116,14 +116,14 @@
      * invoked.
      *
      * \p f will be called on each ethernet frame that is available.
-     * \p f returns a bit vector with one of the following set or cleared:
+     * \p f returns a bit mask with one of the following set or cleared:
      * 
      * data_handler::KEEP  - hold onto the frame and present it again during 
                              the next call to rx_frames, otherwise discard it
      *
-     * data_handler::BREAK - return from rx_frames even though more frames
-     *                       might be available, otherwise continue if more 
-     *                       frames are ready
+     * data_handler::DONE -  return from rx_frames now even though more frames
+     *                       might be available; otherwise continue if more 
+     *                       frames are ready.
      *
      * The idea of holding onto a frame for the next iteration allows
      * the caller to scan the received packet stream for particular