[Discuss-gnuradio] Re: [Commit-gnuradio] r9462 - usrp2/trunk/host/include/usrp2

[Eric Blossom]

On Sat, Aug 30, 2008 at 01:53:36PM -0600, address@hidden wrote:
> Author: jcorgan
> Date: 2008-08-30 13:53:36 -0600 (Sat, 30 Aug 2008)
> New Revision: 9462
> 
> Modified:
>    usrp2/trunk/host/include/usrp2/rx_nop_handler.h
> Log:
> Fix incorrect documentation.
> 
>  
>  namespace usrp2 {
> @@ -90,7 +90,7 @@
>  
>      /*!
>       * Function operator invoked by USRP2 RX API. Derived classes must 
> override this method
> -     * but then invoke it at the end of their processing.  This operator 
> will always be
> +     * but then invoke it at the start of their processing.  This operator 
> will always be
>       * called at least once.
>       *
>       * \param items points to the first 32-bit word of uninterpreted sample 
> data in the frame.

This comment confuses me.  Whether or not the operator gets called
or not should not be documented here.  That's part of the contract of
the API that uses this object.  It's got nothing to do with this
class per se.

Eric