diff options
Diffstat (limited to 'docs/doxygen')
| -rw-r--r-- | docs/doxygen/Doxyfile.in | 27 | ||||
| -rw-r--r-- | docs/doxygen/other/stream_tags.dox | 5 |
2 files changed, 30 insertions, 2 deletions
diff --git a/docs/doxygen/Doxyfile.in b/docs/doxygen/Doxyfile.in index 3b82e2c40c..3f558526e7 100644 --- a/docs/doxygen/Doxyfile.in +++ b/docs/doxygen/Doxyfile.in @@ -142,26 +142,51 @@ STRIP_FROM_PATH = # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = @CMAKE_SOURCE_DIR@/gnuradio-runtime/include \ + @CMAKE_BINARY_DIR@/gnuradio-runtime/include \ @CMAKE_SOURCE_DIR@/gr-analog/include \ + @CMAKE_BINARY_DIR@/gr-analog/include \ @CMAKE_SOURCE_DIR@/gr-atsc/include \ + @CMAKE_BINARY_DIR@/gr-atsc/include \ @CMAKE_SOURCE_DIR@/gr-audio/include \ + @CMAKE_BINARY_DIR@/gr-audio/include \ @CMAKE_SOURCE_DIR@/gr-blocks/include \ + @CMAKE_BINARY_DIR@/gr-blocks/include \ @CMAKE_SOURCE_DIR@/gr-channels/include \ + @CMAKE_BINARY_DIR@/gr-channels/include \ @CMAKE_SOURCE_DIR@/gr-comedi/include \ + @CMAKE_BINARY_DIR@/gr-comedi/include \ @CMAKE_SOURCE_DIR@/gr-digital/include \ + @CMAKE_BINARY_DIR@/gr-digital/include \ + @CMAKE_SOURCE_DIR@/gr-dtv/include \ + @CMAKE_BINARY_DIR@/gr-dtv/include \ @CMAKE_SOURCE_DIR@/gr-fcd/include \ + @CMAKE_BINARY_DIR@/gr-fcd/include \ @CMAKE_SOURCE_DIR@/gr-fec/include \ + @CMAKE_BINARY_DIR@/gr-fec/include \ @CMAKE_SOURCE_DIR@/gr-fft/include \ + @CMAKE_BINARY_DIR@/gr-fft/include \ @CMAKE_SOURCE_DIR@/gr-filter/include \ + @CMAKE_BINARY_DIR@/gr-filter/include \ @CMAKE_SOURCE_DIR@/gr-noaa/include \ + @CMAKE_BINARY_DIR@/gr-noaa/include \ @CMAKE_SOURCE_DIR@/gr-pager/include \ + @CMAKE_BINARY_DIR@/gr-pager/include \ @CMAKE_SOURCE_DIR@/gr-qtgui/include \ + @CMAKE_BINARY_DIR@/gr-qtgui/include \ @CMAKE_SOURCE_DIR@/gr-trellis/include \ + @CMAKE_BINARY_DIR@/gr-trellis/include \ @CMAKE_SOURCE_DIR@/gr-uhd/include \ + @CMAKE_BINARY_DIR@/gr-uhd/include \ @CMAKE_SOURCE_DIR@/gr-video-sdl/include \ + @CMAKE_BINARY_DIR@/gr-video-sdl/include \ @CMAKE_SOURCE_DIR@/gr-vocoder/include \ + @CMAKE_BINARY_DIR@/gr-vocoder/include \ + @CMAKE_SOURCE_DIR@/gr-wavelet/include \ + @CMAKE_BINARY_DIR@/gr-wavelet/include \ @CMAKE_SOURCE_DIR@/gr-wxgui/include \ - @CMAKE_SOURCE_DIR@/volk/include + @CMAKE_BINARY_DIR@/gr-wxgui/include \ + @CMAKE_SOURCE_DIR@/volk/include \ + @CMAKE_BINARY_DIR@/volk/include # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful if your file system diff --git a/docs/doxygen/other/stream_tags.dox b/docs/doxygen/other/stream_tags.dox index 851740984e..d48ec1ddee 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. |