X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=gnuradio-core%2Fsrc%2Flib%2Fgeneral%2Fgr_throttle.h;h=a1c9773c95b19e18663bd42876ac3a156d7269d2;hb=ea29b08aeb54227e6628f655ccfdb96fe4d8c378;hp=2f862c05f6dd1f6c53339519698dba7fe121e287;hpb=09a1e803a9e6587c78d20cdf16891e5295874668;p=debian%2Fgnuradio diff --git a/gnuradio-core/src/lib/general/gr_throttle.h b/gnuradio-core/src/lib/general/gr_throttle.h index 2f862c05..a1c9773c 100644 --- a/gnuradio-core/src/lib/general/gr_throttle.h +++ b/gnuradio-core/src/lib/general/gr_throttle.h @@ -35,9 +35,14 @@ gr_throttle_sptr gr_make_throttle(size_t itemsize, double samples_per_sec); /*! * \brief throttle flow of samples such that the average rate does not exceed samples_per_sec. - * \ingroup block + * \ingroup misc_blk * * input: one stream of itemsize; output: one stream of itemsize + * + * N.B. this should only be used in GUI apps where there is no other + * rate limiting block. It is not intended nor effective at precisely + * controlling the rate of samples. That should be controlled by a + * source or sink tied to sample clock. E.g., a USRP or audio card. */ class gr_throttle : public gr_sync_block {