[Commit-gnuradio] [gnuradio] 03/06: docs: Adds a brief explanation about adding and getting items tags inside/outside calls to work.

[git]

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

trondeau pushed a commit to branch master
in repository gnuradio.

commit efd9bcd21d9f36fb1d85c7d3794bae3d6882feb1
Author: Tom Rondeau <address@hidden>
Date:   Tue Sep 30 21:37:37 2014 -0400

    docs: Adds a brief explanation about adding and getting items tags 
inside/outside calls to work.
    
    Addresses issue #699.
---
 docs/doxygen/other/stream_tags.dox | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/docs/doxygen/other/stream_tags.dox 
b/docs/doxygen/other/stream_tags.dox
index 8517409..d48ec1d 100644
--- a/docs/doxygen/other/stream_tags.dox
+++ b/docs/doxygen/other/stream_tags.dox
@@ -61,7 +61,10 @@ at <em>nitems_written(0)+i</em> for the 0th output port.
 \section stream_tags_api Stream Tags API
 
 The stream tags API consists of four functions, two to add and two to
-get the stream tags. These functions are:
+get the stream tags. These functions are only meant to be accessed
+within a call to general_work/work. While they can be called elsewhere
+in time by a block, the behavior outside of work is undefined without
+exact knowledge of the item counts in the buffers.
 
 \li gr::block::add_item_tag: Adds an item tag to a particular output port 
using a
 gr::tag_t data type.