summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--gr-blocks/include/blocks/annotator_1to1.h4
-rw-r--r--gr-blocks/include/blocks/annotator_alltoall.h1
-rw-r--r--gr-blocks/include/blocks/annotator_raw.h1
-rw-r--r--gr-blocks/include/blocks/bin_statistics_f.h2
-rw-r--r--gr-blocks/include/blocks/check_lfsr_32k_s.h2
-rw-r--r--gr-blocks/include/blocks/lfsr_32k_source_s.h2
-rw-r--r--gr-blocks/include/blocks/multiply_const_vXX.h.t2
-rw-r--r--gr-blocks/include/blocks/vector_map.h2
-rw-r--r--gr-digital/include/digital/chunks_to_symbols_XX.h.t1
-rw-r--r--gr-wavelet/include/wavelet/squash_ff.h14
-rw-r--r--gr-wavelet/include/wavelet/wavelet_ff.h15
-rw-r--r--gr-wavelet/include/wavelet/wvps_ff.h7
12 files changed, 34 insertions, 19 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
diff --git a/gr-digital/include/digital/chunks_to_symbols_XX.h.t b/gr-digital/include/digital/chunks_to_symbols_XX.h.t
index 6ad10ae261..b0ae07bc9e 100644
--- a/gr-digital/include/digital/chunks_to_symbols_XX.h.t
+++ b/gr-digital/include/digital/chunks_to_symbols_XX.h.t
@@ -51,7 +51,6 @@ namespace gr {
* \sa gr::digital::chunks_to_symbols_bf, gr::digital::chunks_to_symbols_bc.
* \sa gr::digital::chunks_to_symbols_sf, gr::digital::chunks_to_symbols_sc.
*/
-
class DIGITAL_API @NAME@ : virtual public gr_sync_interpolator
{
public:
diff --git a/gr-wavelet/include/wavelet/squash_ff.h b/gr-wavelet/include/wavelet/squash_ff.h
index f546148581..77ae4ec9e3 100644
--- a/gr-wavelet/include/wavelet/squash_ff.h
+++ b/gr-wavelet/include/wavelet/squash_ff.h
@@ -29,20 +29,24 @@
namespace gr {
namespace wavelet {
+ /*!
+ * \brief implements cheap resampling of spectrum directly from
+ * spectral points, using gsl interpolation
+ * \ingroup misc
+ */
class WAVELET_API squash_ff : virtual public gr_sync_block
{
public:
// gr::wavelet::squash_ff::sptr
typedef boost::shared_ptr<squash_ff> sptr;
-
+
/*!
- * \brief implements cheap resampling of spectrum directly from
- * spectral points, using gsl interpolation
- * \ingroup misc
+ * \param igrid
+ * \param ogrid
*/
static sptr make(const std::vector<float> &igrid,
- const std::vector<float> &ogrid);
+ const std::vector<float> &ogrid);
};
} /* namespace wavelet */
diff --git a/gr-wavelet/include/wavelet/wavelet_ff.h b/gr-wavelet/include/wavelet/wavelet_ff.h
index 67bb6b19f8..17998ae473 100644
--- a/gr-wavelet/include/wavelet/wavelet_ff.h
+++ b/gr-wavelet/include/wavelet/wavelet_ff.h
@@ -29,6 +29,10 @@
namespace gr {
namespace wavelet {
+ /*!
+ * \brief Compute wavelet transform using gsl routines.
+ * \ingroup wavelet_blk
+ */
class WAVELET_API wavelet_ff : virtual public gr_sync_block
{
public:
@@ -37,14 +41,15 @@ namespace gr {
typedef boost::shared_ptr<wavelet_ff> sptr;
/*!
- * \brief compute wavelet transform using gsl routines
- * \ingroup wavelet_blk
+ * \param size
+ * \param order
+ * \param forward
*/
static sptr make(int size = 1024,
- int order = 20,
- bool forward = true);
+ int order = 20,
+ bool forward = true);
};
-
+
} /* namespace wavelet */
} /* namespace gr */
diff --git a/gr-wavelet/include/wavelet/wvps_ff.h b/gr-wavelet/include/wavelet/wvps_ff.h
index 7f1965a6e7..aca3f73794 100644
--- a/gr-wavelet/include/wavelet/wvps_ff.h
+++ b/gr-wavelet/include/wavelet/wvps_ff.h
@@ -31,6 +31,10 @@ class wavelet_wvps_ff;
namespace gr {
namespace wavelet {
+ /*!
+ * \brief computes the Wavelet Power Spectrum from a set of wavelet coefficients
+ * \ingroup wavelet_blk
+ */
class WAVELET_API wvps_ff : virtual public gr_sync_block
{
public:
@@ -39,8 +43,7 @@ namespace gr {
typedef boost::shared_ptr<wvps_ff> sptr;
/*!
- * \brief computes the Wavelet Power Spectrum from a set of wavelet coefficients
- * \ingroup wavelet_blk
+ \param ilen
*/
static sptr make(int ilen);
};