[Commit-gnuradio] [gnuradio] 02/05: changed the note to a more generic one

[git]

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

jcorgan pushed a commit to branch master
in repository gnuradio.

commit ac0361413bb617a667d93679cdb9139a278534b7
Author: Felix Wunsch <address@hidden>
Date:   Fri Oct 10 09:58:09 2014 +0200

    changed the note to a more generic one
---
 gnuradio-runtime/include/gnuradio/block.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/gnuradio-runtime/include/gnuradio/block.h 
b/gnuradio-runtime/include/gnuradio/block.h
index 4c72f0d..3affb6f 100644
--- a/gnuradio-runtime/include/gnuradio/block.h
+++ b/gnuradio-runtime/include/gnuradio/block.h
@@ -222,7 +222,7 @@ namespace gr {
     /*!
      * \brief Tell the scheduler \p how_many_items of input stream \p
      * which_input were consumed. 
-     * After this call, the input buffer must be considered invalid.
+     * This function should be called at the end of work() or general_work(), 
after all processing is finished.
      */
     void consume(int which_input, int how_many_items);