[Commit-gnuradio] [gnuradio] 01/05: block.h: Added a note to the consume() description to clarify that it must not be called before the buffer is processed.

[git]

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

jcorgan pushed a commit to branch master
in repository gnuradio.

commit 8bc8285aed843fb73c8e341b71193826ad8fcc34
Author: Felix Wunsch <address@hidden>
Date:   Thu Oct 9 12:18:37 2014 +0200

    block.h: Added a note to the consume() description to clarify that it must 
not be called before the buffer is processed.
---
 gnuradio-runtime/include/gnuradio/block.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/gnuradio-runtime/include/gnuradio/block.h 
b/gnuradio-runtime/include/gnuradio/block.h
index 43fc50c..4c72f0d 100644
--- a/gnuradio-runtime/include/gnuradio/block.h
+++ b/gnuradio-runtime/include/gnuradio/block.h
@@ -221,7 +221,8 @@ namespace gr {
 
     /*!
      * \brief Tell the scheduler \p how_many_items of input stream \p
-     * which_input were consumed.
+     * which_input were consumed. 
+     * After this call, the input buffer must be considered invalid.
      */
     void consume(int which_input, int how_many_items);