diff options
| author | Ben Reynwar <ben@reynwar.net> | 2013-04-26 14:01:52 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2013-04-26 14:01:52 -0700 |
| commit | 083c3980e60cb4c3e8211ef14918e985c5065241 (patch) | |
| tree | 3c56e0542b6589e43e3f25170dd0f158bf77aada /gr-blocks | |
| parent | a4532110597639f056198518f058a9d5d89ef8da (diff) | |
docs: Minor improvements to documentation in header files.
Diffstat (limited to 'gr-blocks')
| -rw-r--r-- | gr-blocks/include/blocks/annotator_1to1.h | 4 | ||||
| -rw-r--r-- | gr-blocks/include/blocks/annotator_alltoall.h | 1 | ||||
| -rw-r--r-- | gr-blocks/include/blocks/annotator_raw.h | 1 | ||||
| -rw-r--r-- | gr-blocks/include/blocks/bin_statistics_f.h | 2 | ||||
| -rw-r--r-- | gr-blocks/include/blocks/check_lfsr_32k_s.h | 2 | ||||
| -rw-r--r-- | gr-blocks/include/blocks/lfsr_32k_source_s.h | 2 | ||||
| -rw-r--r-- | gr-blocks/include/blocks/multiply_const_vXX.h.t | 2 | ||||
| -rw-r--r-- | gr-blocks/include/blocks/vector_map.h | 2 |
8 files changed, 10 insertions, 6 deletions
diff --git a/gr-blocks/include/blocks/annotator_1to1.h b/gr-blocks/include/blocks/annotator_1to1.h index 1c5ab038fc..61bc1697c9 100644 --- a/gr-blocks/include/blocks/annotator_1to1.h +++ b/gr-blocks/include/blocks/annotator_1to1.h @@ -31,6 +31,7 @@ namespace gr { /*! * \brief 1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY. + * \ingroup debug_tools_blk * * \details * This block creates tags to be sent downstream every 10,000 @@ -42,7 +43,8 @@ namespace gr { * It also stores a copy of all tags it sees flow past it. These * tags can be recalled externally with the data() member. * - * This block is only meant for testing and showing how to use the tags. + * Warning: This block is only meant for testing and showing how to use the + * tags. */ class BLOCKS_API annotator_1to1 : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/annotator_alltoall.h b/gr-blocks/include/blocks/annotator_alltoall.h index 7bad73b291..fa33d440b8 100644 --- a/gr-blocks/include/blocks/annotator_alltoall.h +++ b/gr-blocks/include/blocks/annotator_alltoall.h @@ -31,6 +31,7 @@ namespace gr { /*! * \brief All-to-all stream annotator testing block. FOR TESTING PURPOSES ONLY. + * \ingroup debug_tools_blk * * \details * This block creates tags to be sent downstream every 10,000 diff --git a/gr-blocks/include/blocks/annotator_raw.h b/gr-blocks/include/blocks/annotator_raw.h index 703c42516a..56c25c808c 100644 --- a/gr-blocks/include/blocks/annotator_raw.h +++ b/gr-blocks/include/blocks/annotator_raw.h @@ -32,6 +32,7 @@ namespace gr { /*! * \brief raw stream annotator testing block. + * \ingroup debug_tools_blk * * \details * This block creates arbitrary tags to be sent downstream blocks diff --git a/gr-blocks/include/blocks/bin_statistics_f.h b/gr-blocks/include/blocks/bin_statistics_f.h index a73afc82d6..a73103866f 100644 --- a/gr-blocks/include/blocks/bin_statistics_f.h +++ b/gr-blocks/include/blocks/bin_statistics_f.h @@ -33,7 +33,7 @@ namespace gr { /*! * \brief control scanning and record frequency domain statistics - * \ingroup sink_blk + * \ingroup misc_blk */ class BLOCKS_API bin_statistics_f : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/check_lfsr_32k_s.h b/gr-blocks/include/blocks/check_lfsr_32k_s.h index 6eddd607b6..89f56d8c90 100644 --- a/gr-blocks/include/blocks/check_lfsr_32k_s.h +++ b/gr-blocks/include/blocks/check_lfsr_32k_s.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief sink that checks if its input stream consists of a lfsr_32k sequence. - * \ingroup sink_blk + * \ingroup misc_blk * * \details * This sink is typically used along with diff --git a/gr-blocks/include/blocks/lfsr_32k_source_s.h b/gr-blocks/include/blocks/lfsr_32k_source_s.h index 9cc32fc2c9..843c7a57e6 100644 --- a/gr-blocks/include/blocks/lfsr_32k_source_s.h +++ b/gr-blocks/include/blocks/lfsr_32k_source_s.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief LFSR pseudo-random source with period of 2^15 bits (2^11 shorts) - * \ingroup source_blk + * \ingroup misc_blk * * \details * This source is typically used along with gr::blocks::check_lfsr_32k_s to diff --git a/gr-blocks/include/blocks/multiply_const_vXX.h.t b/gr-blocks/include/blocks/multiply_const_vXX.h.t index 4cd479f009..e9eb66083e 100644 --- a/gr-blocks/include/blocks/multiply_const_vXX.h.t +++ b/gr-blocks/include/blocks/multiply_const_vXX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input * constant vector (element-wise) - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/vector_map.h b/gr-blocks/include/blocks/vector_map.h index 77a7fc1865..73437b43fb 100644 --- a/gr-blocks/include/blocks/vector_map.h +++ b/gr-blocks/include/blocks/vector_map.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Maps elements from a set of input vectors to a set of output vectors. - * \ingroup slicedice_blk + * \ingroup stream_operators_blk * * \details * If in[i] is the input vector in the i'th stream then the output |