diff options
| author | eb | 2009-05-22 16:11:15 +0000 |
|---|---|---|
| committer | eb | 2009-05-22 16:11:15 +0000 |
| commit | ed236703145cb56e7e69c5605c5fbf01a1ab3878 (patch) | |
| tree | 5d60748c9548b39aa2de4b45a99edabc3f155f0c /gnuradio-core/src | |
| parent | b0bb34bafba903f06c7c9021739a316f5d76eaf7 (diff) | |
| download | gnuradio-ed236703145cb56e7e69c5605c5fbf01a1ab3878.tar.gz gnuradio-ed236703145cb56e7e69c5605c5fbf01a1ab3878.tar.bz2 gnuradio-ed236703145cb56e7e69c5605c5fbf01a1ab3878.zip | |
doc fixes! work-in-progress
git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11085 221aa14e-8319-0410-a670-987f0aec2ac5
Diffstat (limited to 'gnuradio-core/src')
198 files changed, 217 insertions, 220 deletions
diff --git a/gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h b/gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h index ba4e4eec1..f860f4faa 100644 --- a/gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h +++ b/gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h @@ -27,7 +27,7 @@ /*! * \brief Adaptive FIR filter with gr_complex input, gr_complex output and float taps - * \ingroup filter + * \ingroup filter_blk */ class gr_adaptive_fir_ccf : public gr_sync_decimator { diff --git a/gnuradio-core/src/lib/filter/gr_cma_equalizer_cc.h b/gnuradio-core/src/lib/filter/gr_cma_equalizer_cc.h index 06c70f5ba..c78047c16 100644 --- a/gnuradio-core/src/lib/filter/gr_cma_equalizer_cc.h +++ b/gnuradio-core/src/lib/filter/gr_cma_equalizer_cc.h @@ -33,7 +33,7 @@ gr_make_cma_equalizer_cc(int num_taps, float modulus, float mu); /*! * \brief Implements constant modulus adaptive filter on complex stream - * \ingroup filter + * \ingroup eq_blk */ class gr_cma_equalizer_cc : public gr_adaptive_fir_ccf { diff --git a/gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h b/gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h index 278f9ad52..c5363dcbb 100644 --- a/gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h +++ b/gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h @@ -33,7 +33,7 @@ class gri_fft_complex; /*! * \brief Fast FFT filter with gr_complex input, gr_complex output and gr_complex taps - * \ingroup filter + * \ingroup filter_blk */ class gr_fft_filter_ccc : public gr_sync_decimator { diff --git a/gnuradio-core/src/lib/filter/gr_fft_filter_fff.h b/gnuradio-core/src/lib/filter/gr_fft_filter_fff.h index e39ad566e..b26361107 100644 --- a/gnuradio-core/src/lib/filter/gr_fft_filter_fff.h +++ b/gnuradio-core/src/lib/filter/gr_fft_filter_fff.h @@ -34,7 +34,7 @@ class gri_fft_real_rev; /*! * \brief Fast FFT filter with float input, float output and float taps - * \ingroup filter + * \ingroup filter_blk */ class gr_fft_filter_fff : public gr_sync_decimator { diff --git a/gnuradio-core/src/lib/filter/gr_filter_delay_fc.h b/gnuradio-core/src/lib/filter/gr_filter_delay_fc.h index 8ecff0035..946edf2c7 100644 --- a/gnuradio-core/src/lib/filter/gr_filter_delay_fc.h +++ b/gnuradio-core/src/lib/filter/gr_filter_delay_fc.h @@ -37,7 +37,7 @@ class gr_fir_fff; /*! * \brief Filter-Delay Combination Block. - * \ingroup filter + * \ingroup filter_blk * * The block takes one or two float stream and outputs a complex * stream. If only one float stream is input, the real output is diff --git a/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h b/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h index 2e0240ca0..14ff1e6b1 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h @@ -26,7 +26,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_ccc - * \ingroup filter + * \ingroup filter_primitive * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. diff --git a/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h b/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h index 637310ce4..ebc6a1bc0 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h @@ -27,7 +27,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_ccf - * \ingroup filter + * \ingroup filter_primitive * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. diff --git a/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h b/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h index 1da73d741..7f936546f 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h +++ b/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h @@ -27,7 +27,7 @@ /*! * \brief 3DNow! version of gr_fir_ccf - * \ingroup filter + * \ingroup filter_primitive */ class gr_fir_ccf_3dnow : public gr_fir_ccf_simd { @@ -38,7 +38,7 @@ public: /*! * \brief SSE version of gr_fir_ccf - * \ingroup filter + * \ingroup filter_primitive */ class gr_fir_ccf_sse : public gr_fir_ccf_simd { diff --git a/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h b/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h index e8815e987..e2ed8bcae 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h @@ -27,7 +27,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_fcc - * \ingroup filter + * \ingroup filter_primitive * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. diff --git a/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h b/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h index 02d75fa46..49386c35d 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h @@ -27,7 +27,7 @@ /*! * \brief 3DNow! version of gr_fir_fcc - * \ingroup filter + * \ingroup filter_primitive */ class gr_fir_fcc_3dnow : public gr_fir_fcc_simd { @@ -38,7 +38,7 @@ public: /*! * \brief SSE version of gr_fir_fcc - * \ingroup filter + * \ingroup filter_blk */ class gr_fir_fcc_sse : public gr_fir_fcc_simd { diff --git a/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h b/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h index a3bb38366..82d3e3b99 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h @@ -26,7 +26,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_fff - * \ingroup filter + * \ingroup filter_primitive * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. diff --git a/gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t b/gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t index 6c283b62b..f2e56c901 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t +++ b/gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t @@ -38,7 +38,7 @@ class @FIR_TYPE@; /*! * \brief FIR filter with @I_TYPE@ input, @O_TYPE@ output and @TAP_TYPE@ taps - * \ingroup filter + * \ingroup filter_blk */ class @NAME@ : public gr_sync_decimator { diff --git a/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h b/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h index 6a42327e0..ad689407d 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h @@ -26,7 +26,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_fsf - * \ingroup filter + * \ingroup filter_primitive * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. diff --git a/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h b/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h index 1f4501ed0..42ef62084 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h @@ -27,7 +27,7 @@ /*! * \brief 3DNow! version of gr_fir_fsf - * \ingroup filter + * \ingroup filter_blk */ class gr_fir_fsf_3dnow : public gr_fir_fsf_simd { @@ -38,7 +38,7 @@ public: /*! * \brief SSE version of gr_fir_fsf - * \ingroup filter + * \ingroup filter_blk */ class gr_fir_fsf_sse : public gr_fir_fsf_simd { diff --git a/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h b/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h index 6bd7f1765..8ecdb6a20 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h @@ -27,7 +27,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_scc - * \ingroup filter + * \ingroup filter_blk * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. diff --git a/gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h b/gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h index 6bbf9ca11..c8378c43e 100644 --- a/gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h +++ b/gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h @@ -35,7 +35,7 @@ gr_fractional_interpolator_cc_sptr gr_make_fractional_interpolator_cc (float pha /*! * \brief Interpolating mmse filter with gr_complex input, gr_complex output - * \ingroup filter + * \ingroup filter_blk */ class gr_fractional_interpolator_cc : public gr_block { diff --git a/gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h b/gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h index 53ea24ace..f50129289 100644 --- a/gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h +++ b/gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h @@ -35,7 +35,7 @@ gr_fractional_interpolator_ff_sptr gr_make_fractional_interpolator_ff (float pha /*! * \brief Interpolating mmse filter with float input, float output - * \ingroup filter + * \ingroup filter_blk */ class gr_fractional_interpolator_ff : public gr_block { diff --git a/gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t b/gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t index ba0db8a6b..1205e8a08 100644 --- a/gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t +++ b/gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t @@ -49,7 +49,7 @@ class @FIR_TYPE@; /*! * \brief FIR filter combined with frequency translation with @I_TYPE@ input, @O_TYPE@ output and @TAP_TYPE@ taps - * \ingroup filter + * \ingroup filter_blk * * This class efficiently combines a frequency translation * (typically "down conversion") with a FIR filter (typically low-pass) diff --git a/gnuradio-core/src/lib/filter/gr_goertzel_fc.h b/gnuradio-core/src/lib/filter/gr_goertzel_fc.h index 60e0cc17f..9518c5c92 100644 --- a/gnuradio-core/src/lib/filter/gr_goertzel_fc.h +++ b/gnuradio-core/src/lib/filter/gr_goertzel_fc.h @@ -34,7 +34,7 @@ gr_goertzel_fc_sptr gr_make_goertzel_fc(int rate, int len, float freq); /*! * \brief Goertzel single-bin DFT calculation. - * \ingroup dft + * \ingroup dft_blk */ class gr_goertzel_fc : public gr_sync_decimator { diff --git a/gnuradio-core/src/lib/filter/gr_hilbert_fc.h b/gnuradio-core/src/lib/filter/gr_hilbert_fc.h index 53366c734..adcac7793 100644 --- a/gnuradio-core/src/lib/filter/gr_hilbert_fc.h +++ b/gnuradio-core/src/lib/filter/gr_hilbert_fc.h @@ -38,7 +38,7 @@ class gr_fir_fff; /*! * \brief Hilbert transformer. - * \ingroup filter + * \ingroup filter_blk * * real output is input appropriately delayed. * imaginary output is hilbert filtered (90 degree phase shift) diff --git a/gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h b/gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h index 92a844986..0382646f1 100644 --- a/gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h +++ b/gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h @@ -35,7 +35,7 @@ gr_make_iir_filter_ffd (const std::vector<double> &fftaps, /*! * \brief IIR filter with float input, float output and double taps - * \ingroup filter + * \ingroup filter_blk * * This filter uses the Direct Form I implementation, where * \p fftaps contains the feed-forward taps, and \p fbtaps the feedback ones. diff --git a/gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t b/gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t index ee886d8f9..790e0b908 100644 --- a/gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t +++ b/gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t @@ -38,7 +38,7 @@ class @FIR_TYPE@; /*! * \brief Interpolating FIR filter with @I_TYPE@ input, @O_TYPE@ output and @TAP_TYPE@ taps - * \ingroup filter + * \ingroup filter_blk */ class @NAME@ : public gr_sync_interpolator { diff --git a/gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t b/gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t index 3cb269a20..983b350fa 100644 --- a/gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t +++ b/gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t @@ -42,7 +42,7 @@ class @FIR_TYPE@; /*! * \brief Rational Resampling Polyphase FIR filter with @I_TYPE@ input, @O_TYPE@ output and @TAP_TYPE@ taps - * \ingroup filter + * \ingroup filter_blk */ class @NAME@ : public gr_block { diff --git a/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h b/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h index 7ae878d81..1f1073424 100644 --- a/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h +++ b/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h @@ -36,7 +36,7 @@ gr_make_single_pole_iir_filter_cc (double alpha, unsigned int vlen=1); /*! * \brief single pole IIR filter with complex input, complex output - * \ingroup filter + * \ingroup filter_blk * * The input and output satisfy a difference equation of the form diff --git a/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h b/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h index 15499d99d..f676e94bc 100644 --- a/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h +++ b/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h @@ -35,7 +35,7 @@ gr_make_single_pole_iir_filter_ff (double alpha, unsigned int vlen=1); /*! * \brief single pole IIR filter with float input, float output - * \ingroup filter + * \ingroup filter_blk * * The input and output satisfy a difference equation of the form diff --git a/gnuradio-core/src/lib/filter/gri_goertzel.h b/gnuradio-core/src/lib/filter/gri_goertzel.h index a42ab08cd..86d3d34d3 100644 --- a/gnuradio-core/src/lib/filter/gri_goertzel.h +++ b/gnuradio-core/src/lib/filter/gri_goertzel.h @@ -27,9 +27,8 @@ /*! * \brief Implements Goertzel single-bin DFT calculation - * \ingroup dft + * \ingroup misc */ - class gri_goertzel { public: diff --git a/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h b/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h index 60c0d4bc6..616520ad6 100644 --- a/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h +++ b/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h @@ -28,7 +28,7 @@ class gr_fir_fff; /*! * \brief Compute intermediate samples between signal samples x(k*Ts) - * \ingroup filter + * \ingroup filter_primitive * * This implements a Mininum Mean Squared Error interpolator with 8 taps. * It is suitable for signals where the bandwidth of interest B = 1/(4*Ts) diff --git a/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h b/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h index 6f94c7c80..daf8b19b8 100644 --- a/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h +++ b/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h @@ -29,7 +29,7 @@ class gr_fir_ccf; /*! * \brief Compute intermediate samples between signal samples x(k*Ts) - * \ingroup filter + * \ingroup filter_primitive * * This implements a Mininum Mean Squared Error interpolator with 8 taps. * It is suitable for signals where the bandwidth of interest B = 1/(4*Ts) diff --git a/gnuradio-core/src/lib/general/gr_agc2_cc.h b/gnuradio-core/src/lib/general/gr_agc2_cc.h index e27359e70..0eb20afb9 100644 --- a/gnuradio-core/src/lib/general/gr_agc2_cc.h +++ b/gnuradio-core/src/lib/general/gr_agc2_cc.h @@ -34,7 +34,7 @@ gr_make_agc2_cc (float attack_rate = 1e-1, float decay_rate = 1e-2, float refere float gain = 1.0, float max_gain = 0.0); /*! * \brief high performance Automatic Gain Control class - * \ingroup level + * \ingroup level_blk * * For Power the absolute value of the complex number is used. */ diff --git a/gnuradio-core/src/lib/general/gr_agc2_ff.h b/gnuradio-core/src/lib/general/gr_agc2_ff.h index 61ebac1f1..ef470765f 100644 --- a/gnuradio-core/src/lib/general/gr_agc2_ff.h +++ b/gnuradio-core/src/lib/general/gr_agc2_ff.h @@ -34,7 +34,7 @@ gr_make_agc2_ff (float attack_rate = 1e-1, float decay_rate = 1e-2, float refere /*! * \brief high performance Automatic Gain Control class * - * \ingroup level + * \ingroup level_blk * Power is approximated by absolute value */ diff --git a/gnuradio-core/src/lib/general/gr_agc_cc.h b/gnuradio-core/src/lib/general/gr_agc_cc.h index 56bc8aaa4..43a5de6c7 100644 --- a/gnuradio-core/src/lib/general/gr_agc_cc.h +++ b/gnuradio-core/src/lib/general/gr_agc_cc.h @@ -33,7 +33,7 @@ gr_make_agc_cc (float rate = 1e-4, float reference = 1.0, float gain = 1.0, float max_gain = 0.0); /*! * \brief high performance Automatic Gain Control class - * \ingroup level + * \ingroup level_blk * * For Power the absolute value of the complex number is used. */ diff --git a/gnuradio-core/src/lib/general/gr_agc_ff.h b/gnuradio-core/src/lib/general/gr_agc_ff.h index 45872a2a5..7cb167fca 100644 --- a/gnuradio-core/src/lib/general/gr_agc_ff.h +++ b/gnuradio-core/src/lib/general/gr_agc_ff.h @@ -34,7 +34,7 @@ gr_make_agc_ff (float rate = 1e-4, float reference = 1.0, /*! * \brief high performance Automatic Gain Control class - * \ingroup level + * \ingroup level_blk * * Power is approximated by absolute value */ diff --git a/gnuradio-core/src/lib/general/gr_bin_statistics_f.h b/gnuradio-core/src/lib/general/gr_bin_statistics_f.h index 3ba019b2f..d8c4c2fae 100644 --- a/gnuradio-core/src/lib/general/gr_bin_statistics_f.h +++ b/gnuradio-core/src/lib/general/gr_bin_statistics_f.h @@ -42,7 +42,7 @@ gr_make_bin_statistics_f(unsigned int vlen, // vector length /*! * \brief control scanning and record frequency domain statistics - * \ingroup sink + * \ingroup sink_blk */ class gr_bin_statistics_f : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_binary_slicer_fb.h b/gnuradio-core/src/lib/general/gr_binary_slicer_fb.h index 267a07147..2aa4a0828 100644 --- a/gnuradio-core/src/lib/general/gr_binary_slicer_fb.h +++ b/gnuradio-core/src/lib/general/gr_binary_slicer_fb.h @@ -32,7 +32,7 @@ gr_binary_slicer_fb_sptr gr_make_binary_slicer_fb (); /*! * \brief slice float binary symbol outputting 1 bit output - * \ingroup converter + * \ingroup converter_blk * * x < 0 --> 0 * x >= 0 --> 1 diff --git a/gnuradio-core/src/lib/general/gr_bytes_to_syms.h b/gnuradio-core/src/lib/general/gr_bytes_to_syms.h index 47596c934..1531de02a 100644 --- a/gnuradio-core/src/lib/general/gr_bytes_to_syms.h +++ b/gnuradio-core/src/lib/general/gr_bytes_to_syms.h @@ -31,7 +31,7 @@ gr_bytes_to_syms_sptr gr_make_bytes_to_syms (); /*! * \brief Convert stream of bytes to stream of +/- 1 symbols - * \ingroup converter + * \ingroup converter_blk * * input: stream of bytes; output: stream of float * diff --git a/gnuradio-core/src/lib/general/gr_char_to_float.h b/gnuradio-core/src/lib/general/gr_char_to_float.h index b96441724..482e479d6 100644 --- a/gnuradio-core/src/lib/general/gr_char_to_float.h +++ b/gnuradio-core/src/lib/general/gr_char_to_float.h @@ -33,7 +33,7 @@ gr_make_char_to_float (); /*! * \brief Convert stream of chars to a stream of float - * \ingroup converter + * \ingroup converter_blk */ class gr_char_to_float : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_check_counting_s.h b/gnuradio-core/src/lib/general/gr_check_counting_s.h index 2795dfa32..da35ab8e2 100644 --- a/gnuradio-core/src/lib/general/gr_check_counting_s.h +++ b/gnuradio-core/src/lib/general/gr_check_counting_s.h @@ -32,7 +32,7 @@ gr_check_counting_s_sptr gr_make_check_counting_s (bool do_32bit=false); /*! * \brief sink that checks if its input stream consists of a counting sequence. * \param do_32bit expect an interleaved 32 bit counter in stead of 16 bit counter (default false) - * \ingroup sink + * \ingroup sink_blk * * This sink is typically used to test the USRP "Counting Mode" or "Counting mode 32 bit". */ diff --git a/gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h b/gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h index dfc14efca..e2bff46d2 100644 --- a/gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h +++ b/gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h @@ -33,7 +33,7 @@ gr_check_lfsr_32k_s_sptr gr_make_check_lfsr_32k_s (); /*! * \brief sink that checks if its input stream consists of a lfsr_32k sequence. - * \ingroup sink + * \ingroup sink_blk * * This sink is typically used along with gr_lfsr_32k_source_s to test * the USRP using its digital loopback mode. diff --git a/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h b/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h index e4819ef60..d7af64d3f 100644 --- a/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h +++ b/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h @@ -39,7 +39,7 @@ gr_make_clock_recovery_mm_cc (float omega, float gain_omega, float mu, float gai /*! * \brief Mueller and Müller (M&M) based clock recovery block with complex input, complex output. - * \ingroup clock + * \ingroup synch_blk * * This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer. * The complex version here is based on: diff --git a/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h b/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h index 582685cc5..89833d343 100644 --- a/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h +++ b/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h @@ -39,7 +39,7 @@ gr_make_clock_recovery_mm_ff (float omega, float gain_omega, float mu, float gai /*! * \brief Mueller and Müller (M&M) based clock recovery block with float input, float output. - * \ingroup clock + * \ingroup synch_blk * * This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer. * diff --git a/gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h b/gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h index de3292ccc..0a91eddd6 100644 --- a/gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h +++ b/gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h @@ -34,7 +34,7 @@ gr_make_complex_to_interleaved_short (); /*! * \brief Convert stream of complex to a stream of interleaved shorts - * \ingroup converter + * \ingroup converter_blk */ class gr_complex_to_interleaved_short : public gr_sync_interpolator diff --git a/gnuradio-core/src/lib/general/gr_complex_to_xxx.h b/gnuradio-core/src/lib/general/gr_complex_to_xxx.h index b6d3aa02f..1851c67d9 100644 --- a/gnuradio-core/src/lib/general/gr_complex_to_xxx.h +++ b/gnuradio-core/src/lib/general/gr_complex_to_xxx.h @@ -49,7 +49,7 @@ gr_complex_to_arg_sptr gr_make_complex_to_arg (unsigned int vlen=1); /*! * \brief convert a stream of gr_complex to 1 or 2 streams of float - * \ingroup converter + * \ingroup converter_blk * \param vlen vector len (default 1) */ class gr_complex_to_float : public gr_sync_block @@ -67,7 +67,7 @@ class gr_complex_to_float : public gr_sync_block /*! * \brief complex in, real out (float) - * \ingroup converter + * \ingroup converter_blk * \param vlen vector len (default 1) */ class gr_complex_to_real : public gr_sync_block @@ -85,7 +85,7 @@ class gr_complex_to_real : public gr_sync_block /*! * \brief complex in, imaginary out (float) - * \ingroup converter + * \ingroup converter_blk * \param vlen vector len (default 1) */ class gr_complex_to_imag : public gr_sync_block @@ -103,7 +103,7 @@ class gr_complex_to_imag : public gr_sync_block /*! * \brief complex in, magnitude out (float) - * \ingroup converter + * \ingroup converter_blk * \param vlen vector len (default 1) */ class gr_complex_to_mag : public gr_sync_block @@ -121,7 +121,7 @@ class gr_complex_to_mag : public gr_sync_block /*! * \brief complex in, magnitude squared out (float) - * \ingroup converter + * \ingroup converter_blk * \param vlen vector len (default 1) */ class gr_complex_to_mag_squared : public gr_sync_block @@ -139,7 +139,7 @@ class gr_complex_to_mag_squared : public gr_sync_block /*! * \brief complex in, angle out (float) - * \ingroup converter + * \ingroup converter_blk * \param vlen vector len (default 1) */ class gr_complex_to_arg : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_conjugate_cc.h b/gnuradio-core/src/lib/general/gr_conjugate_cc.h index 29dd95e60..783019adb 100644 --- a/gnuradio-core/src/lib/general/gr_conjugate_cc.h +++ b/gnuradio-core/src/lib/general/gr_conjugate_cc.h @@ -34,7 +34,7 @@ gr_conjugate_cc_sptr gr_make_conjugate_cc (); /*! * \brief output = complex conjugate of input - * \ingroup math + * \ingroup math_blk */ class gr_conjugate_cc : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h b/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h index 52c397799..fd7079c12 100644 --- a/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h +++ b/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h @@ -35,7 +35,7 @@ gr_constellation_decoder_cb_sptr /*! * \brief Constellation Decoder - * \ingroup coding + * \ingroup coding_blk * */ class gr_constellation_decoder_cb : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h b/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h index 4dd3a78a1..622eee75d 100644 --- a/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h +++ b/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h @@ -38,7 +38,7 @@ gr_make_correlate_access_code_bb (const std::string &access_code, int threshold) /*! * \brief Examine input for specified access code, one bit at a time. - * \ingroup synch + * \ingroup synch_blk * * input: stream of bits, 1 bit per input byte (data in LSB) * output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit) diff --git a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h index d48ddb938..c034cd1f1 100644 --- a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h +++ b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h @@ -30,7 +30,7 @@ /*! \brief A Costas loop carrier recovery module. - * \ingroup clock + * \ingroup synch_blk * * The Costas loop locks to the center frequency of a signal and * downconverts it to baseband. The second (order=2) order loop is @@ -49,8 +49,8 @@ * * \param alpha the loop gain used for phase adjustment * \param beta the loop gain for frequency adjustments - * \param max_freq the maximum frequency deviation (normalized frequency) the loop can handle - * \param min_freq the minimum frequency deviation (normalized frequency) the loop can handle + * \param max_freq the maximum frequency deviation (radians/sample) the loop can handle + * \param min_freq the minimum frequency deviation (radians/sample) the loop can handle * \param order the loop order, either 2 or 4 */ class gr_costas_loop_cc; @@ -66,7 +66,7 @@ gr_make_costas_loop_cc (float alpha, float beta, /*! * \brief Carrier tracking PLL for QPSK - * \ingroup clock + * \ingroup synch_blk * input: complex; output: complex * <br>The Costas loop can have two output streams: * stream 1 is the baseband I and Q; diff --git a/gnuradio-core/src/lib/general/gr_cpfsk_bc.h b/gnuradio-core/src/lib/general/gr_cpfsk_bc.h index 1678a2964..29bcfed65 100644 --- a/gnuradio-core/src/lib/general/gr_cpfsk_bc.h +++ b/gnuradio-core/src/lib/general/gr_cpfsk_bc.h @@ -31,7 +31,7 @@ gr_cpfsk_bc_sptr gr_make_cpfsk_bc(float k, float ampl, int samples_per_sym); /*! * \brief Perform continuous phase 2-level frequency shift keying modulation * on an input stream of unpacked bits. - * \ingroup modulation + * \ingroup modulation_blk * * \param k modulation index * \param ampl output amplitude diff --git a/gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h b/gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h index 7b708867b..49df785ff 100644 --- a/gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h +++ b/gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h @@ -34,7 +34,7 @@ gr_make_ctcss_squelch_ff(int rate, float freq, float level=0.01, int len=0, int /*! * \brief gate or zero output if ctcss tone not present - * \ingroup level + * \ingroup level_blk */ class gr_ctcss_squelch_ff : public gr_squelch_base_ff { diff --git a/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h b/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h index 3153d5b05..9bd1d9e5a 100644 --- a/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h +++ b/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h @@ -37,7 +37,7 @@ gr_make_dd_mpsk_sync_cc (float alpha, float beta, /*! * \brief Decision directed M-PSK synchronous demod - * \ingroup clock + * \ingroup synch_blk * This block performs joint carrier tracking and symbol timing recovery. * * input: complex baseband; output: properly timed complex samples ready for slicing. diff --git a/gnuradio-core/src/lib/general/gr_deinterleave.h b/gnuradio-core/src/lib/general/gr_deinterleave.h index 714b9e1df..59c310bdc 100644 --- a/gnuradio-core/src/lib/general/gr_deinterleave.h +++ b/gnuradio-core/src/lib/general/gr_deinterleave.h @@ -32,7 +32,7 @@ gr_deinterleave_sptr gr_make_deinterleave (size_t itemsize); /*! * \brief deinterleave a single input into N outputs - * \ingroup misc + * \ingroup slicedice_blk */ class gr_deinterleave : public gr_sync_decimator { diff --git a/gnuradio-core/src/lib/general/gr_delay.h b/gnuradio-core/src/lib/general/gr_delay.h index aa25a5773..d7e8252a2 100644 --- a/gnuradio-core/src/lib/general/gr_delay.h +++ b/gnuradio-core/src/lib/general/gr_delay.h @@ -32,7 +32,7 @@ gr_delay_sptr gr_make_delay (size_t itemsize, int delay); /*! * \brief delay the input by a certain number of samples - * \ingroup misc + * \ingroup misc_blk */ class gr_delay : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_diff_decoder_bb.h b/gnuradio-core/src/lib/general/gr_diff_decoder_bb.h index ddb519d66..6fd08ec4b 100644 --- a/gnuradio-core/src/lib/general/gr_diff_decoder_bb.h +++ b/gnuradio-core/src/lib/general/gr_diff_decoder_bb.h @@ -32,7 +32,7 @@ gr_diff_decoder_bb_sptr gr_make_diff_decoder_bb (unsigned int modulus); /*! * \brief y[0] = (x[0] - x[-1]) % M - * \ingroup coding + * \ingroup coding_blk * * Differential decoder */ diff --git a/gnuradio-core/src/lib/general/gr_diff_encoder_bb.h b/gnuradio-core/src/lib/general/gr_diff_encoder_bb.h index 9cc13313f..50aff73cf 100644 --- a/gnuradio-core/src/lib/general/gr_diff_encoder_bb.h +++ b/gnuradio-core/src/lib/general/gr_diff_encoder_bb.h @@ -32,7 +32,7 @@ gr_diff_encoder_bb_sptr gr_make_diff_encoder_bb (unsigned int modulus); /*! * \brief y[0] = (x[0] + y[-1]) % M - * \ingroup coding + * \ingroup coding_blk * * Differential encoder */ diff --git a/gnuradio-core/src/lib/general/gr_dpll_bb.h b/gnuradio-core/src/lib/general/gr_dpll_bb.h index e1e60c1b1..e6b5fc0fa 100644 --- a/gnuradio-core/src/lib/general/gr_dpll_bb.h +++ b/gnuradio-core/src/lib/general/gr_dpll_bb.h @@ -32,7 +32,7 @@ gr_dpll_bb_sptr gr_make_dpll_bb (float period, float gain); /*! * \brief Detect the peak of a signal - * \ingroup level + * \ingroup level_blk * * If a peak is detected, this block outputs a 1, * or it outputs 0's. diff --git a/gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h b/gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h index 7c64a577e..480fb8e78 100644 --- a/gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h +++ b/gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h @@ -33,7 +33,7 @@ gr_make_fake_channel_encoder_pp(int input_vlen, int output_vlen); /*! * \brief pad packet with alternating 1,0 pattern. - * \ingroup coding + * \ingroup coding_blk * * input: stream of byte vectors; output: stream of byte vectors */ @@ -65,7 +65,7 @@ gr_make_fake_channel_decoder_pp(int input_vlen, int output_vlen); /*! * \brief remove fake padding from packet - * \ingroup coding + * \ingroup coding_blk * * input: stream of byte vectors; output: stream of byte vectors */ diff --git a/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h b/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h index b7e46bd1e..8c600d3d1 100644 --- a/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h +++ b/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h @@ -33,7 +33,7 @@ gr_make_feedforward_agc_cc(int nsamples, float reference = 1.0); /*! * \brief Non-causal AGC which computes required gain based on max absolute value over nsamples - * \ingroup level + * \ingroup level_blk */ class gr_feedforward_agc_cc : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_fft_vcc.h b/gnuradio-core/src/lib/general/gr_fft_vcc.h index 705cbdd64..2ab9241ec 100644 --- a/gnuradio-core/src/lib/general/gr_fft_vcc.h +++ b/gnuradio-core/src/lib/general/gr_fft_vcc.h @@ -33,7 +33,7 @@ gr_make_fft_vcc (int fft_size, bool forward, const std::vector<float> &window, b /*! * \brief Compute forward or reverse FFT. complex vector in / complex vector out. - * \ingroup dft + * \ingroup dft_blk * * Abstract base class */ diff --git a/gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h b/gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h index 93c8d3cce..c026162ee 100644 --- a/gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h +++ b/gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h @@ -32,7 +32,7 @@ gr_make_fft_vcc_fftw (int fft_size, bool forward, const std::vector<float> &wind /*! * \brief Compute forward or reverse FFT. complex vector in / complex vector out. - * \ingroup dft + * \ingroup dft_blk * * Concrete class that uses FFTW. */ diff --git a/gnuradio-core/src/lib/general/gr_fft_vfc.h b/gnuradio-core/src/lib/general/gr_fft_vfc.h index e7f71de8b..054a383ef 100644 --- a/gnuradio-core/src/lib/general/gr_fft_vfc.h +++ b/gnuradio-core/src/lib/general/gr_fft_vfc.h @@ -35,7 +35,7 @@ gr_make_fft_vfc (int fft_size, bool forward, const std::vector<float>); /*! * \brief Compute forward FFT. float vector in / complex vector out. - * \ingroup dft + * \ingroup dft_blk */ class gr_fft_vfc : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_float_to_char.h b/gnuradio-core/src/lib/general/gr_float_to_char.h index 6d635b2e7..e65072bf0 100644 --- a/gnuradio-core/src/lib/general/gr_float_to_char.h +++ b/gnuradio-core/src/lib/general/gr_float_to_char.h @@ -33,7 +33,7 @@ gr_make_float_to_char (); /*! * \brief Convert stream of float to a stream of char - * \ingroup converter + * \ingroup converter_blk */ class gr_float_to_char : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_float_to_complex.h b/gnuradio-core/src/lib/general/gr_float_to_complex.h index 0c82d7209..f6cc24852 100644 --- a/gnuradio-core/src/lib/general/gr_float_to_complex.h +++ b/gnuradio-core/src/lib/general/gr_float_to_complex.h @@ -34,7 +34,7 @@ gr_make_float_to_complex (size_t vlen = 1); /*! * \brief Convert 1 or 2 streams of float to a stream of gr_complex - * \ingroup converter + * \ingroup converter_blk */ class gr_float_to_complex : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_float_to_short.h b/gnuradio-core/src/lib/general/gr_float_to_short.h index 3c6d60b89..e85343929 100644 --- a/gnuradio-core/src/lib/general/gr_float_to_short.h +++ b/gnuradio-core/src/lib/general/gr_float_to_short.h @@ -33,7 +33,7 @@ gr_make_float_to_short (); /*! * \brief Convert stream of float to a stream of short - * \ingroup converter + * \ingroup converter_blk */ class gr_float_to_short : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_float_to_uchar.h b/gnuradio-core/src/lib/general/gr_float_to_uchar.h index 912753ac6..3bca9c555 100644 --- a/gnuradio-core/src/lib/general/gr_float_to_uchar.h +++ b/gnuradio-core/src/lib/general/gr_float_to_uchar.h @@ -33,7 +33,7 @@ gr_make_float_to_uchar (); /*! * \brief Convert stream of float to a stream of unsigned char - * \ingroup converter + * \ingroup converter_blk */ class gr_float_to_uchar : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_framer_sink_1.h b/gnuradio-core/src/lib/general/gr_framer_sink_1.h index 1fbf69263..3f2e8aa88 100644 --- a/gnuradio-core/src/lib/general/gr_framer_sink_1.h +++ b/gnuradio-core/src/lib/general/gr_framer_sink_1.h @@ -34,7 +34,7 @@ gr_make_framer_sink_1 (gr_msg_queue_sptr target_queue); /*! * \brief Given a stream of bits and access_code flags, assemble packets. - * \ingroup sink + * \ingroup sink_blk * * input: stream of bytes from gr_correlate_access_code_bb * output: none. Pushes assembled packet into target queue diff --git a/gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h b/gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h index c8512a305..4ba05d709 100644 --- a/gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h +++ b/gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h @@ -32,7 +32,7 @@ gr_frequency_modulator_fc_sptr gr_make_frequency_modulator_fc (double sensitivit /*! * \brief Frequency modulator block - * \ingroup modulation + * \ingroup modulation_blk * * float input; complex baseband output */ diff --git a/gnuradio-core/src/lib/general/gr_fxpt.h b/gnuradio-core/src/lib/general/gr_fxpt.h index da733cdae..520729f8d 100644 --- a/gnuradio-core/src/lib/general/gr_fxpt.h +++ b/gnuradio-core/src/lib/general/gr_fxpt.h @@ -26,7 +26,7 @@ /*! * \brief fixed point sine and cosine and friends. - * \ingroup math + * \ingroup misc * * fixed pt radians * --------- -------- diff --git a/gnuradio-core/src/lib/general/gr_glfsr_source_b.h b/gnuradio-core/src/lib/general/gr_glfsr_source_b.h index 99fa84e1a..cff8df11b 100644 --- a/gnuradio-core/src/lib/general/gr_glfsr_source_b.h +++ b/gnuradio-core/src/lib/general/gr_glfsr_source_b.h @@ -34,7 +34,7 @@ gr_glfsr_source_b_sptr gr_make_glfsr_source_b(int degree, bool repeat=true, int /*! * \brief Galois LFSR pseudo-random source - * \ingroup source + * \ingroup source_blk */ class gr_glfsr_source_b : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_glfsr_source_f.h b/gnuradio-core/src/lib/general/gr_glfsr_source_f.h index 8887e8f7d..007970806 100644 --- a/gnuradio-core/src/lib/general/gr_glfsr_source_f.h +++ b/gnuradio-core/src/lib/general/gr_glfsr_source_f.h @@ -34,7 +34,7 @@ gr_glfsr_source_f_sptr gr_make_glfsr_source_f(int degree, bool repeat=true, int /*! * \brief Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0 - * \ingroup source + * \ingroup source_blk */ class gr_glfsr_source_f : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_head.h b/gnuradio-core/src/lib/general/gr_head.h index 97104b890..cd97d6399 100644 --- a/gnuradio-core/src/lib/general/gr_head.h +++ b/gnuradio-core/src/lib/general/gr_head.h @@ -28,7 +28,7 @@ /*! * \brief copies the first N items to the output then signals done - * \ingroup flow + * \ingroup slicedice_blk * * Useful for building test cases */ diff --git a/gnuradio-core/src/lib/general/gr_interleave.h b/gnuradio-core/src/lib/general/gr_interleave.h index d8901f92b..faffdd757 100644 --- a/gnuradio-core/src/lib/general/gr_interleave.h +++ b/gnuradio-core/src/lib/general/gr_interleave.h @@ -32,7 +32,7 @@ gr_interleave_sptr gr_make_interleave (size_t itemsize); /*! * \brief interleave N inputs to a single output - * \ingroup misc + * \ingroup slicedice_blk */ class gr_interleave : public gr_sync_interpolator { diff --git a/gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h b/gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h index 534737079..c79a9370f 100644 --- a/gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h +++ b/gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h @@ -34,7 +34,7 @@ gr_make_interleaved_short_to_complex (); /*! * \brief Convert stream of interleaved shorts to a stream of complex - * \ingroup converter + * \ingroup converter_blk */ class gr_interleaved_short_to_complex : public gr_sync_decimator diff --git a/gnuradio-core/src/lib/general/gr_iqcomp_cc.h b/gnuradio-core/src/lib/general/gr_iqcomp_cc.h index 77be5085d..f4c6cf8ea 100644 --- a/gnuradio-core/src/lib/general/gr_iqcomp_cc.h +++ b/gnuradio-core/src/lib/general/gr_iqcomp_cc.h @@ -33,7 +33,7 @@ gr_iqcomp_cc_sptr gr_make_iqcomp_cc (float mu); /*! * \brief - * \ingroup + * \ingroup misc_blk */ class gr_iqcomp_cc : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_keep_one_in_n.h b/gnuradio-core/src/lib/general/gr_keep_one_in_n.h index 0ed9d0bca..337827446 100644 --- a/gnuradio-core/src/lib/general/gr_keep_one_in_n.h +++ b/gnuradio-core/src/lib/general/gr_keep_one_in_n.h @@ -34,7 +34,7 @@ gr_make_keep_one_in_n (size_t item_size, int n); /*! * \brief decimate a stream, keeping one item out of every n. - * \ingroup misc + * \ingroup slicedice_blk */ class gr_keep_one_in_n : public gr_block { diff --git a/gnuradio-core/src/lib/general/gr_kludge_copy.h b/gnuradio-core/src/lib/general/gr_kludge_copy.h index b56a2f4c5..90fd047df 100644 --- a/gnuradio-core/src/lib/general/gr_kludge_copy.h +++ b/gnuradio-core/src/lib/general/gr_kludge_copy.h @@ -32,7 +32,7 @@ gr_kludge_copy_sptr gr_make_kludge_copy(size_t itemsize); /*! * \brief output[i] = input[i] - * \ingroup misc + * \ingroup misc_blk * * This is a short term kludge to work around a problem with the hierarchical block impl. */ diff --git a/gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h b/gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h index 6485bb8b0..f8497e4cb 100644 --- a/gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h +++ b/gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h @@ -33,7 +33,7 @@ gr_lfsr_32k_source_s_sptr gr_make_lfsr_32k_source_s (); /*! * \brief LFSR pseudo-random source with period of 2^15 bits (2^11 shorts) - * \ingroup source + * \ingroup source_blk * * This source is typically used along with gr_check_lfsr_32k_s to test * the USRP using its digital loopback mode. diff --git a/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h b/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h index 10d862f0d..7b3a2c84e 100644 --- a/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h +++ b/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h @@ -33,7 +33,7 @@ gr_lms_dfe_cc_sptr gr_make_lms_dfe_cc (float lambda_ff, float lambda_fb, /*! * \brief Least-Mean-Square Decision Feedback Equalizer (complex in/out) - * \ingroup misc + * \ingroup eq_blk */ class gr_lms_dfe_cc : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_lms_dfe_ff.h b/gnuradio-core/src/lib/general/gr_lms_dfe_ff.h index 16e3a69ec..dd610c470 100644 --- a/gnuradio-core/src/lib/general/gr_lms_dfe_ff.h +++ b/gnuradio-core/src/lib/general/gr_lms_dfe_ff.h @@ -33,7 +33,7 @@ gr_lms_dfe_ff_sptr gr_make_lms_dfe_ff (float lambda_ff, float lambda_fb, /*! * \brief Least-Mean-Square Decision Feedback Equalizer (float in/out) - * \ingroup misc + * \ingroup eq_blk */ class gr_lms_dfe_ff : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_map_bb.h b/gnuradio-core/src/lib/general/gr_map_bb.h index a37f2fc2f..4986ab181 100644 --- a/gnuradio-core/src/lib/general/gr_map_bb.h +++ b/gnuradio-core/src/lib/general/gr_map_bb.h @@ -31,7 +31,7 @@ gr_map_bb_sptr gr_make_map_bb(const std::vector<int> &map); /*! * \brief output[i] = map[input[i]] - * \ingroup misc + * \ingroup coding_blk */ class gr_map_bb : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_math.h b/gnuradio-core/src/lib/general/gr_math.h index 9dd9680e3..ea0f20027 100644 --- a/gnuradio-core/src/lib/general/gr_math.h +++ b/gnuradio-core/src/lib/general/gr_math.h @@ -50,7 +50,7 @@ int gr_signbit (double x); /*! * \brief Fast arc tangent using table lookup and linear interpolation - * \ingroup math + * \ingroup misc * * \param y component of input vector * \param x component of input vector diff --git a/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h b/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h index b3ce9cea2..5c3b253af 100644 --- a/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h +++ b/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h @@ -43,7 +43,7 @@ gr_make_mpsk_receiver_cc (unsigned int M, float theta, /*! * \brief This block takes care of receiving M-PSK modulated signals through phase, frequency, and symbol * synchronization. - * \ingroup synch + * \ingroup synch_blk * * This block takes care of receiving M-PSK modulated signals through phase, frequency, and symbol * synchronization. It performs carrier frequency and phase locking as well as symbol timing recovery. diff --git a/gnuradio-core/src/lib/general/gr_nlog10_ff.h b/gnuradio-core/src/lib/general/gr_nlog10_ff.h index 352685ecd..1cb50f3ca 100644 --- a/gnuradio-core/src/lib/general/gr_nlog10_ff.h +++ b/gnuradio-core/src/lib/general/gr_nlog10_ff.h @@ -31,7 +31,7 @@ gr_nlog10_ff_sptr gr_make_nlog10_ff (float n=1.0, unsigned vlen=1, float k=0); /*! * \brief output = n*log10(input) + k - * \ingroup math + * \ingroup math_blk */ class gr_nlog10_ff : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_nop.h b/gnuradio-core/src/lib/general/gr_nop.h index 20d66d17e..60b20c5ab 100644 --- a/gnuradio-core/src/lib/general/gr_nop.h +++ b/gnuradio-core/src/lib/general/gr_nop.h @@ -28,7 +28,7 @@ /*! * \brief Does nothing. Used for testing only. - * \ingroup misc + * \ingroup misc_blk */ class gr_nop : public gr_block { diff --git a/gnuradio-core/src/lib/general/gr_null_sink.h b/gnuradio-core/src/lib/general/gr_null_sink.h index f1595b1f1..66df5d138 100644 --- a/gnuradio-core/src/lib/general/gr_null_sink.h +++ b/gnuradio-core/src/lib/general/gr_null_sink.h @@ -28,7 +28,7 @@ /*! * \brief Bit bucket - * \ingroup sink + * \ingroup sink_blk */ class gr_null_sink : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_null_source.h b/gnuradio-core/src/lib/general/gr_null_source.h index 78fb0f729..63b1939bf 100644 --- a/gnuradio-core/src/lib/general/gr_null_source.h +++ b/gnuradio-core/src/lib/general/gr_null_source.h @@ -27,7 +27,7 @@ /*! * \brief A source of zeros. - * \ingroup source + * \ingroup source_blk */ class gr_null_source : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h b/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h index 0d8764cee..c4244f828 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h @@ -37,7 +37,7 @@ gr_make_ofdm_bpsk_demapper (unsigned int occupied_carriers); /*! * \brief take a vector of complex constellation points in from an FFT * and demodulate to a stream of bits. Simple BPSK version. - * \ingroup demodulation + * \ingroup demodulation_blk */ class gr_ofdm_bpsk_demapper : public gr_block diff --git a/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h b/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h index d34665a9a..6b6dc5784 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h @@ -36,7 +36,7 @@ gr_make_ofdm_cyclic_prefixer (size_t input_size, size_t output_size); /*! * \brief adds a cyclic prefix vector to an input size long ofdm * symbol(vector) and converts vector to a stream output_size long. - * \ingroup synch + * \ingroup synch_blk */ class gr_ofdm_cyclic_prefixer : public gr_sync_interpolator { diff --git a/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h b/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h index 42295cddb..22dea54bc 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h @@ -36,7 +36,7 @@ gr_make_ofdm_demapper_vcb (unsigned int bits_per_symbol, unsigned int vlen); * \brief take a stream of vectors in from an FFT and demodulate to a stream of * bits. Abstract class must be subclassed with specific mapping. * - * \ingroup demodulation + * \ingroup demodulation_blk */ class gr_ofdm_demapper_vcb : public gr_sync_decimator diff --git a/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h b/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h index 1fdf64897..38fec9263 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h @@ -39,7 +39,7 @@ gr_make_ofdm_frame_acquisition (unsigned int occupied_carriers, unsigned int fft /*! * \brief take a vector of complex constellation points in from an FFT * and performs a correlation and equalization. - * \ingroup demodulation + * \ingroup demodulation_blk * * This block takes the output of an FFT of a received OFDM symbol and finds the * start of a frame based on two known symbols. It also looks at the surrounding diff --git a/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h b/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h index 91d559eb0..729806dae 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h @@ -38,7 +38,7 @@ gr_make_ofdm_frame_sink (const std::vector<gr_complex> &sym_position, /*! * \brief Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs * them into packets, and sends to to a message queue sink. - * \ingroup sink + * \ingroup sink_blk * NOTE: The mod input parameter simply chooses a pre-defined demapper/slicer. Eventually, * we want to be able to pass in a reference to an object to do the demapping and slicing * for a given modulation type. diff --git a/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h b/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h index 0b6b6ae02..2d1007c25 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h @@ -34,7 +34,7 @@ gr_make_ofdm_insert_preamble(int fft_length, /*! * \brief insert "pre-modulated" preamble symbols before each payload. - * \ingroup synch + * \ingroup synch_blk * * <pre> * input 1: stream of vectors of gr_complex [fft_length] diff --git a/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h b/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h index 6704c8b2a..b75d9ee3b 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h @@ -38,7 +38,7 @@ gr_make_ofdm_mapper_bcv (const std::vector<gr_complex> &constellation, unsigned * \brief take a stream of bytes in and map to a vector of complex * constellation points suitable for IFFT input to be used in an ofdm * modulator. Abstract class must be subclassed with specific mapping. - * \ingroup modulation + * \ingroup modulation_blk * */ diff --git a/gnuradio-core/src/lib/general/gr_pa_2x2_phase_combiner.h b/gnuradio-core/src/lib/general/gr_pa_2x2_phase_combiner.h index 239b463d8..ec163911a 100644 --- a/gnuradio-core/src/lib/general/gr_pa_2x2_phase_combiner.h +++ b/gnuradio-core/src/lib/general/gr_pa_2x2_phase_combiner.h @@ -31,7 +31,7 @@ gr_pa_2x2_phase_combiner_sptr gr_make_pa_2x2_phase_combiner (); /*! * \brief pa_2x2 phase combiner - * \ingroup misc + * \ingroup misc_blk * * Anntenas are arranged like this: * diff --git a/gnuradio-core/src/lib/general/gr_packet_sink.h b/gnuradio-core/src/lib/general/gr_packet_sink.h index ba01bf600..73c5d6c52 100644 --- a/gnuradio-core/src/lib/general/gr_packet_sink.h +++ b/gnuradio-core/src/lib/general/gr_packet_sink.h @@ -36,7 +36,7 @@ gr_make_packet_sink (const std::vector<unsigned char>& sync_vector, ); /*! * \brief process received bits looking for packet sync, header, and process bits into packet - * \ingroup sink + * \ingroup sink_blk */ class gr_packet_sink : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_peak_detector2_fb.h b/gnuradio-core/src/lib/general/gr_peak_detector2_fb.h index 85bf577e0..58a006246 100644 --- a/gnuradio-core/src/lib/general/gr_peak_detector2_fb.h +++ b/gnuradio-core/src/lib/general/gr_peak_detector2_fb.h @@ -34,7 +34,7 @@ gr_peak_detector2_fb_sptr gr_make_peak_detector2_fb (float threshold_factor_rise /*! * \brief Detect the peak of a signal - * \ingroup level + * \ingroup level_blk * * If a peak is detected, this block outputs a 1, * or it outputs 0's. A separate debug output may be connected, to diff --git a/gnuradio-core/src/lib/general/gr_phase_modulator_fc.h b/gnuradio-core/src/lib/general/gr_phase_modulator_fc.h index 828edf62b..50157534b 100644 --- a/gnuradio-core/src/lib/general/gr_phase_modulator_fc.h +++ b/gnuradio-core/src/lib/general/gr_phase_modulator_fc.h @@ -32,7 +32,7 @@ gr_phase_modulator_fc_sptr gr_make_phase_modulator_fc (double sensitivity); /*! * \brief Phase modulator block - * \ingroup modulation + * \ingroup modulation_blk * output=complex(cos(in*sensitivity),sin(in*sensitivity)) */ class gr_phase_modulator_fc : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h index 2033fe177..f3a93741f 100644 --- a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h +++ b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h @@ -33,7 +33,7 @@ gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, floa /*! * \brief Implements a PLL which locks to the input frequency and outputs the * input signal mixed with that carrier. - * \ingroup clock + * \ingroup synch_blk * * input: stream of complex; output: stream of complex * diff --git a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h index 2235a6904..bc462780f 100644 --- a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h +++ b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h @@ -33,7 +33,7 @@ gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float alpha, float beta, /*! * \brief Implements a PLL which locks to the input frequency and outputs * an estimate of that frequency. Useful for FM Demod. - * \ingroup clock + * \ingroup synch_blk * * input: stream of complex; output: stream of floats * diff --git a/gnuradio-core/src/lib/general/gr_pll_refout_cc.h b/gnuradio-core/src/lib/general/gr_pll_refout_cc.h index 6f8370fe9..9c91b87f3 100644 --- a/gnuradio-core/src/lib/general/gr_pll_refout_cc.h +++ b/gnuradio-core/src/lib/general/gr_pll_refout_cc.h @@ -34,7 +34,7 @@ gr_pll_refout_cc_sptr gr_make_pll_refout_cc (float alpha, float beta, float max_freq, float min_freq); /*! * \brief Implements a PLL which locks to the input frequency and outputs a carrier - * \ingroup clock + * \ingroup synch_blk * * input: stream of complex; output: stream of complex * diff --git a/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h b/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h index 12aad470d..933aff02b 100644 --- a/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h +++ b/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h @@ -34,7 +34,7 @@ gr_make_pn_correlator_cc(int degree, int mask=0, int seed=1); /*! * \brief PN code sequential search correlator * - * \ingroup synch + * \ingroup synch_blk * Receives complex baseband signal, outputs complex correlation against * reference PN code, one sample per PN code period */ diff --git a/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h b/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h index 158f9eaa6..ee8872010 100644 --- a/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h +++ b/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h @@ -33,7 +33,7 @@ gr_make_probe_avg_mag_sqrd_c (double threshold_db, double alpha = 0.0001); /*! * \brief compute avg magnitude squared. - * \ingroup sink + * \ingroup sink_blk * * input: gr_complex * diff --git a/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h b/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h index ee3833547..6c536ca5b 100644 --- a/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h +++ b/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h @@ -33,7 +33,7 @@ gr_make_probe_avg_mag_sqrd_cf (double threshold_db, double alpha = 0.0001); /*! * \brief compute avg magnitude squared. - * \ingroup sink + * \ingroup sink_blk * * input: gr_complex * output: gr_float diff --git a/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h b/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h index 3908dc6b1..b31e54f6b 100644 --- a/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h +++ b/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h @@ -33,7 +33,7 @@ gr_make_probe_avg_mag_sqrd_f (double threshold_db, double alpha = 0.0001); /*! * \brief compute avg magnitude squared. - * \ingroup sink + * \ingroup sink_blk * * input: float * diff --git a/gnuradio-core/src/lib/general/gr_probe_mpsk_snr_c.h b/gnuradio-core/src/lib/general/gr_probe_mpsk_snr_c.h index 67492f686..279a4a5b8 100644 --- a/gnuradio-core/src/lib/general/gr_probe_mpsk_snr_c.h +++ b/gnuradio-core/src/lib/general/gr_probe_mpsk_snr_c.h @@ -37,7 +37,7 @@ gr_make_probe_mpsk_snr_c(double alpha = 0.0001); * This technique assumes an AWGN channel. * * \param alpha Mean and variance smoothing filter constant - * \ingroup sink + * \ingroup sink_blk * * Compute the running average of the signal mean and noise variance. * The estimated signal mean, noise variance, and SNR are available diff --git a/gnuradio-core/src/lib/general/gr_probe_signal_f.h b/gnuradio-core/src/lib/general/gr_probe_signal_f.h index 85ddef5b9..9605bb685 100644 --- a/gnuradio-core/src/lib/general/gr_probe_signal_f.h +++ b/gnuradio-core/src/lib/general/gr_probe_signal_f.h @@ -32,7 +32,7 @@ gr_make_probe_signal_f (); /*! * \brief Sink that allows a sample to be grabbed from Python. - * \ingroup sink + * \ingroup sink_blk */ class gr_probe_signal_f : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h b/gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h index 2628b5687..9c519f383 100644 --- a/gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h +++ b/gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h @@ -35,7 +35,7 @@ gr_make_pwr_squelch_cc(double db, double alpha = 0.0001, int ramp=0, bool gate=f /*! * \brief gate or zero output when input power below threshold - * \ingroup level + * \ingroup level_blk */ class gr_pwr_squelch_cc : public gr_squelch_base_cc { diff --git a/gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h b/gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h index 229ce595e..6952dbce2 100644 --- a/gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h +++ b/gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h @@ -35,7 +35,7 @@ gr_make_pwr_squelch_ff(double db, double alpha = 0.0001, int ramp=0, bool gate=f /*! * \brief gate or zero output when input power below threshold - * \ingroup level + * \ingroup level_blk */ class gr_pwr_squelch_ff : public gr_squelch_base_ff { diff --git a/gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h b/gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h index 8ccb0ce2d..a29acd628 100644 --- a/gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h +++ b/gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h @@ -31,7 +31,7 @@ gr_quadrature_demod_cf_sptr gr_make_quadrature_demod_cf (float gain); /*! * \brief quadrature demodulator: complex in, float out - * \ingroup demodulation + * \ingroup demodulation_blk * * This can be used to demod FM, FSK, GMSK, etc. * The input is complex baseband. diff --git a/gnuradio-core/src/lib/general/gr_random.h b/gnuradio-core/src/lib/general/gr_random.h index 2ee2a021a..e5002fd33 100644 --- a/gnuradio-core/src/lib/general/gr_random.h +++ b/gnuradio-core/src/lib/general/gr_random.h @@ -27,7 +27,7 @@ /*! * \brief pseudo random number generator - * \ingroup math + * \ingroup math_blk */ class gr_random { protected: diff --git a/gnuradio-core/src/lib/general/gr_regenerate_bb.h b/gnuradio-core/src/lib/general/gr_regenerate_bb.h index 751bc5157..db511b228 100644 --- a/gnuradio-core/src/lib/general/gr_regenerate_bb.h +++ b/gnuradio-core/src/lib/general/gr_regenerate_bb.h @@ -32,7 +32,7 @@ gr_regenerate_bb_sptr gr_make_regenerate_bb (int period, unsigned int max_regen= /*! * \brief Detect the peak of a signal and repeat every period samples - * \ingroup level + * \ingroup level_blk * * If a peak is detected, this block outputs a 1 repeated every period samples * until reset by detection of another 1 on the input or stopped after max_regen diff --git a/gnuradio-core/src/lib/general/gr_repeat.h b/gnuradio-core/src/lib/general/gr_repeat.h index a392b79e8..f323fc375 100644 --- a/gnuradio-core/src/lib/general/gr_repeat.h +++ b/gnuradio-core/src/lib/general/gr_repeat.h @@ -32,7 +32,7 @@ gr_repeat_sptr gr_make_repeat(size_t itemsize, int interp); /*! * \brief Repeat a sample 'interp' times in output stream - * \ingroup converter + * \ingroup misc_blk */ class gr_repeat : public gr_sync_interpolator diff --git a/gnuradio-core/src/lib/general/gr_rms_cf.h b/gnuradio-core/src/lib/general/gr_rms_cf.h index 024a0ce3f..86c4bdbac 100644 --- a/gnuradio-core/src/lib/general/gr_rms_cf.h +++ b/gnuradio-core/src/lib/general/gr_rms_cf.h @@ -33,7 +33,7 @@ gr_make_rms_cf (double alpha = 0.0001); /*! * \brief RMS average power - * \ingroup math + * \ingroup math_blk */ class gr_rms_cf : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_rms_ff.h b/gnuradio-core/src/lib/general/gr_rms_ff.h index f41f4d418..ed1635eb1 100644 --- a/gnuradio-core/src/lib/general/gr_rms_ff.h +++ b/gnuradio-core/src/lib/general/gr_rms_ff.h @@ -33,7 +33,7 @@ gr_make_rms_ff (double alpha = 0.0001); /*! * \brief RMS average power - * \ingroup math + * \ingroup math_blk */ class gr_rms_ff : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_scrambler_bb.h b/gnuradio-core/src/lib/general/gr_scrambler_bb.h index 1dfa60dfb..7efe8b598 100644 --- a/gnuradio-core/src/lib/general/gr_scrambler_bb.h +++ b/gnuradio-core/src/lib/general/gr_scrambler_bb.h @@ -39,7 +39,7 @@ gr_scrambler_bb_sptr gr_make_scrambler_bb(int mask, int seed, int len); * \param seed Initial shift register contents * \param len Shift register length * - * \ingroup misc + * \ingroup coding_blk */ class gr_scrambler_bb : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_short_to_float.h b/gnuradio-core/src/lib/general/gr_short_to_float.h index 9d19a7578..ccb19d9f2 100644 --- a/gnuradio-core/src/lib/general/gr_short_to_float.h +++ b/gnuradio-core/src/lib/general/gr_short_to_float.h @@ -33,7 +33,7 @@ gr_make_short_to_float (); /*! * \brief Convert stream of short to a stream of float - * \ingroup converter + * \ingroup converter_blk */ class gr_short_to_float : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_simple_correlator.h b/gnuradio-core/src/lib/general/gr_simple_correlator.h index 8fb336b42..319d9427f 100644 --- a/gnuradio-core/src/lib/general/gr_simple_correlator.h +++ b/gnuradio-core/src/lib/general/gr_simple_correlator.h @@ -35,7 +35,7 @@ gr_simple_correlator_sptr gr_make_simple_correlator (int payload_bytesize); /*! * \brief inverse of gr_simple_framer (more or less) - * \ingroup synch + * \ingroup synch_blk */ class gr_simple_correlator : public gr_block { diff --git a/gnuradio-core/src/lib/general/gr_simple_framer.h b/gnuradio-core/src/lib/general/gr_simple_framer.h index 29c198822..de38fd9ba 100644 --- a/gnuradio-core/src/lib/general/gr_simple_framer.h +++ b/gnuradio-core/src/lib/general/gr_simple_framer.h @@ -32,7 +32,7 @@ gr_simple_framer_sptr gr_make_simple_framer (int payload_bytesize); /*! * \brief add sync field, seq number and command field to payload - * \ingroup synch + * \ingroup synch_blk */ class gr_simple_framer : public gr_block { diff --git a/gnuradio-core/src/lib/general/gr_simple_framer_sync.h b/gnuradio-core/src/lib/general/gr_simple_framer_sync.h index 1dbaff828..eaf3ef635 100644 --- a/gnuradio-core/src/lib/general/gr_simple_framer_sync.h +++ b/gnuradio-core/src/lib/general/gr_simple_framer_sync.h @@ -28,7 +28,7 @@ * the "mseq" matlab/octave code downloaded from: * http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=990&objectType=file * - * \ingroup synch + * \ingroup synch_blk * 31-bit m-sequence: * 0110100100001010111011000111110 * 0x690AEC76 (padded on right with a zero) diff --git a/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h b/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h index 135331634..30744f6fb 100644 --- a/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h +++ b/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h @@ -33,7 +33,7 @@ gr_make_simple_squelch_cc (double threshold_db, double alpha = 0.0001); /*! * \brief simple squelch block based on average signal power and threshold in dB. - * \ingroup level + * \ingroup level_blk */ class gr_simple_squelch_cc : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_skiphead.h b/gnuradio-core/src/lib/general/gr_skiphead.h index c479bab0c..965feff9b 100644 --- a/gnuradio-core/src/lib/general/gr_skiphead.h +++ b/gnuradio-core/src/lib/general/gr_skiphead.h @@ -32,7 +32,7 @@ typedef boost::shared_ptr<gr_skiphead> gr_skiphead_sptr; /*! * \brief skips the first N items, from then on copies items to the output - * \ingroup flow + * \ingroup slicedice_blk * * Useful for building test cases and sources which have metadata or junk at the start */ diff --git a/gnuradio-core/src/lib/general/gr_stream_mux.h b/gnuradio-core/src/lib/general/gr_stream_mux.h index b8c06b35d..29829339e 100644 --- a/gnuradio-core/src/lib/general/gr_stream_mux.h +++ b/gnuradio-core/src/lib/general/gr_stream_mux.h @@ -30,7 +30,7 @@ /*! * \brief Creates a stream muxing block to multiplex many streams into * one with a specified format. - * \ingroup converter + * \ingroup converter_blk * * \param itemsize the item size of the stream * \param length a vector (list/tuple) specifying the number of diff --git a/gnuradio-core/src/lib/general/gr_stream_to_streams.h b/gnuradio-core/src/lib/general/gr_stream_to_streams.h index 5e0cddffe..2fdd39e4a 100644 --- a/gnuradio-core/src/lib/general/gr_stream_to_streams.h +++ b/gnuradio-core/src/lib/general/gr_stream_to_streams.h @@ -33,7 +33,7 @@ gr_make_stream_to_streams (size_t item_size, size_t nstreams); /*! * \brief convert a stream of items into a N streams of items - * \ingroup converter + * \ingroup slicedice_blk * * Converts a stream of N items into N streams of 1 item. * Repeat ad infinitum. diff --git a/gnuradio-core/src/lib/general/gr_stream_to_vector.h b/gnuradio-core/src/lib/general/gr_stream_to_vector.h index 067e8742b..2cb03f6a8 100644 --- a/gnuradio-core/src/lib/general/gr_stream_to_vector.h +++ b/gnuradio-core/src/lib/general/gr_stream_to_vector.h @@ -34,7 +34,7 @@ gr_make_stream_to_vector (size_t item_size, size_t nitems_per_block); /*! * \brief convert a stream of items into a stream of blocks containing nitems_per_block - * \ingroup converter + * \ingroup slicedice_blk */ class gr_stream_to_vector : public gr_sync_decimator { diff --git a/gnuradio-core/src/lib/general/gr_streams_to_stream.h b/gnuradio-core/src/lib/general/gr_streams_to_stream.h index e3f27d5b8..044af6cd2 100644 --- a/gnuradio-core/src/lib/general/gr_streams_to_stream.h +++ b/gnuradio-core/src/lib/general/gr_streams_to_stream.h @@ -33,7 +33,7 @@ gr_make_streams_to_stream (size_t item_size, size_t nstreams); /*! * \brief Convert N streams of 1 item into a 1 stream of N items - * \ingroup converter + * \ingroup slicedice_blk * * Convert N streams of 1 item into 1 stream of N items. * Repeat ad infinitum. diff --git a/gnuradio-core/src/lib/general/gr_streams_to_vector.h b/gnuradio-core/src/lib/general/gr_streams_to_vector.h index 0813638c4..1b2e3ebf7 100644 --- a/gnuradio-core/src/lib/general/gr_streams_to_vector.h +++ b/gnuradio-core/src/lib/general/gr_streams_to_vector.h @@ -34,7 +34,7 @@ gr_make_streams_to_vector (size_t item_size, size_t nstreams); /*! * \brief convert N streams of items to 1 stream of vector length N - * \ingroup converter + * \ingroup slicedice_blk */ class gr_streams_to_vector : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_stretch_ff.h b/gnuradio-core/src/lib/general/gr_stretch_ff.h index be828f583..e75e1969f 100644 --- a/gnuradio-core/src/lib/general/gr_stretch_ff.h +++ b/gnuradio-core/src/lib/general/gr_stretch_ff.h @@ -29,7 +29,7 @@ * \brief adjust y-range of an input vector by mapping to range * (max-of-input, stipulated-min). Primarily for spectral signature * matching by normalizing spectrum dynamic ranges. - * \ingroup misc + * \ingroup misc_blk */ diff --git a/gnuradio-core/src/lib/general/gr_test.h b/gnuradio-core/src/lib/general/gr_test.h index 978d1395c..5438ac701 100644 --- a/gnuradio-core/src/lib/general/gr_test.h +++ b/gnuradio-core/src/lib/general/gr_test.h @@ -49,12 +49,7 @@ gr_test_sptr gr_make_test (const std::string &name=std::string("gr_test"), * factor and/or large output_multiple. * The runtime system should detect this and create large enough buffers * all through the signal chain. - * */ - - - - class gr_test : public gr_block { public: diff --git a/gnuradio-core/src/lib/general/gr_threshold_ff.h b/gnuradio-core/src/lib/general/gr_threshold_ff.h index 01f28aedc..65b677a77 100644 --- a/gnuradio-core/src/lib/general/gr_threshold_ff.h +++ b/gnuradio-core/src/lib/general/gr_threshold_ff.h @@ -32,7 +32,7 @@ gr_threshold_ff_sptr gr_make_threshold_ff (float lo, float hi, float initial_sta /*! * \brief Please fix my documentation - * \ingroup misc + * \ingroup misc_blk */ class gr_threshold_ff : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_throttle.h b/gnuradio-core/src/lib/general/gr_throttle.h index f1c29c3cd..a1c9773c9 100644 --- a/gnuradio-core/src/lib/general/gr_throttle.h +++ b/gnuradio-core/src/lib/general/gr_throttle.h @@ -35,9 +35,14 @@ gr_throttle_sptr gr_make_throttle(size_t itemsize, double samples_per_sec); /*! * \brief throttle flow of samples such that the average rate does not exceed samples_per_sec. - * \ingroup flow + * \ingroup misc_blk * * input: one stream of itemsize; output: one stream of itemsize + * + * N.B. this should only be used in GUI apps where there is no other + * rate limiting block. It is not intended nor effective at precisely + * controlling the rate of samples. That should be controlled by a + * source or sink tied to sample clock. E.g., a USRP or audio card. */ class gr_throttle : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_uchar_to_float.h b/gnuradio-core/src/lib/general/gr_uchar_to_float.h index a9bbc1007..3b83c893f 100644 --- a/gnuradio-core/src/lib/general/gr_uchar_to_float.h +++ b/gnuradio-core/src/lib/general/gr_uchar_to_float.h @@ -33,7 +33,7 @@ gr_make_uchar_to_float (); /*! * \brief Convert stream of unsigned chars to a stream of float - * \ingroup converter + * \ingroup converter_blk */ class gr_uchar_to_float : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h b/gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h index a24a4b731..e2be2c59c 100644 --- a/gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h +++ b/gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h @@ -33,7 +33,7 @@ class gr_unpack_k_bits_bb; /*! * \brief Converts a byte with k relevent bits to k output bytes with 1 bit in the LSB. - * \ingroup converter + * \ingroup converter_blk */ class gr_unpack_k_bits_bb : public gr_sync_interpolator { diff --git a/gnuradio-core/src/lib/general/gr_vco_f.h b/gnuradio-core/src/lib/general/gr_vco_f.h index 8e5400443..2bdf60899 100644 --- a/gnuradio-core/src/lib/general/gr_vco_f.h +++ b/gnuradio-core/src/lib/general/gr_vco_f.h @@ -41,6 +41,7 @@ gr_vco_f_sptr gr_make_vco_f(double sampling_rate, double sensitivity, double amp /*! * \brief VCO - Voltage controlled oscillator + * \ingroup modulator_blk * * input: float stream of control voltages; output: float oscillator output */ diff --git a/gnuradio-core/src/lib/general/gr_vector_to_stream.h b/gnuradio-core/src/lib/general/gr_vector_to_stream.h index e29cd2e50..de6cc2a8b 100644 --- a/gnuradio-core/src/lib/general/gr_vector_to_stream.h +++ b/gnuradio-core/src/lib/general/gr_vector_to_stream.h @@ -34,7 +34,7 @@ gr_make_vector_to_stream (size_t item_size, size_t nitems_per_block); /*! * \brief convert a stream of blocks of nitems_per_block items into a stream of items - * \ingroup converter + * \ingroup slicedice_blk */ class gr_vector_to_stream : public gr_sync_interpolator { diff --git a/gnuradio-core/src/lib/general/gr_vector_to_streams.h b/gnuradio-core/src/lib/general/gr_vector_to_streams.h index 5d1ba75f1..d5ba7acf9 100644 --- a/gnuradio-core/src/lib/general/gr_vector_to_streams.h +++ b/gnuradio-core/src/lib/general/gr_vector_to_streams.h @@ -34,7 +34,7 @@ gr_make_vector_to_streams (size_t item_size, size_t nstreams); /*! * \brief Convert 1 stream of vectors of length N to N streams of items - * \ingroup converter + * \ingroup slicedice_blk */ class gr_vector_to_streams : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_wavelet_ff.h b/gnuradio-core/src/lib/general/gr_wavelet_ff.h index 1e98d2e49..dcfb595e5 100644 --- a/gnuradio-core/src/lib/general/gr_wavelet_ff.h +++ b/gnuradio-core/src/lib/general/gr_wavelet_ff.h @@ -38,7 +38,7 @@ gr_make_wavelet_ff(int size = 1024, /*! * \brief compute wavelet transform using gsl routines - * \ingroup math + * \ingroup wavelet_blk */ class gr_wavelet_ff : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_wvps_ff.h b/gnuradio-core/src/lib/general/gr_wvps_ff.h index ced9646bb..af122d0fc 100644 --- a/gnuradio-core/src/lib/general/gr_wvps_ff.h +++ b/gnuradio-core/src/lib/general/gr_wvps_ff.h @@ -34,7 +34,7 @@ gr_make_wvps_ff(int ilen); /*! * \brief computes the Wavelet Power Spectrum from a set of wavelet coefficients - * \ingroup misc + * \ingroup wavelet_blk */ class gr_wvps_ff : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gri_agc2_cc.h b/gnuradio-core/src/lib/general/gri_agc2_cc.h index 04b8f3122..441d1e459 100644 --- a/gnuradio-core/src/lib/general/gri_agc2_cc.h +++ b/gnuradio-core/src/lib/general/gri_agc2_cc.h @@ -27,11 +27,9 @@ /*! * \brief high performance Automatic Gain Control class - * \ingroup level * * For Power the absolute value of the complex number is used. */ - class gri_agc2_cc { public: diff --git a/gnuradio-core/src/lib/general/gri_agc2_ff.h b/gnuradio-core/src/lib/general/gri_agc2_ff.h index d83ed180a..a06dab78c 100644 --- a/gnuradio-core/src/lib/general/gri_agc2_ff.h +++ b/gnuradio-core/src/lib/general/gri_agc2_ff.h @@ -27,7 +27,6 @@ /*! * \brief high performance Automatic Gain Control class with attack and decay rate - * \ingroup level * * Power is approximated by absolute value */ diff --git a/gnuradio-core/src/lib/general/gri_agc_cc.h b/gnuradio-core/src/lib/general/gri_agc_cc.h index 1d8a764e8..bc31d9a3d 100644 --- a/gnuradio-core/src/lib/general/gri_agc_cc.h +++ b/gnuradio-core/src/lib/general/gri_agc_cc.h @@ -27,7 +27,6 @@ /*! * \brief high performance Automatic Gain Control class - * \ingroup level * * For Power the absolute value of the complex number is used. */ diff --git a/gnuradio-core/src/lib/general/gri_agc_ff.h b/gnuradio-core/src/lib/general/gri_agc_ff.h index 53cf61f0e..de609a8d4 100644 --- a/gnuradio-core/src/lib/general/gri_agc_ff.h +++ b/gnuradio-core/src/lib/general/gri_agc_ff.h @@ -27,11 +27,9 @@ /*! * \brief high performance Automatic Gain Control class - * \ingroup level * * Power is approximated by absolute value */ - class gri_agc_ff { public: diff --git a/gnuradio-core/src/lib/general/gri_fft.h b/gnuradio-core/src/lib/general/gri_fft.h index 720084eb6..21d6ffdaf 100644 --- a/gnuradio-core/src/lib/general/gri_fft.h +++ b/gnuradio-core/src/lib/general/gri_fft.h @@ -44,7 +44,7 @@ public: /*! * \brief FFT: complex in, complex out - * \ingroup dft + * \ingroup misc */ class gri_fft_complex { int d_fft_size; @@ -75,7 +75,7 @@ public: /*! * \brief FFT: real in, complex out - * \ingroup dft + * \ingroup dft_blk */ class gri_fft_real_fwd { int d_fft_size; @@ -106,7 +106,7 @@ public: /*! * \brief FFT: complex in, float out - * \ingroup dft + * \ingroup dft_blk */ class gri_fft_real_rev { int d_fft_size; diff --git a/gnuradio-core/src/lib/general/gri_glfsr.h b/gnuradio-core/src/lib/general/gri_glfsr.h index 7b4fe7c06..7dd5f8660 100644 --- a/gnuradio-core/src/lib/general/gri_glfsr.h +++ b/gnuradio-core/src/lib/general/gri_glfsr.h @@ -25,7 +25,7 @@ /*! * \brief Galois Linear Feedback Shift Register using specified polynomial mask - * \ingroup math + * \ingroup misc * * Generates a maximal length pseudo-random sequence of length 2^degree-1 */ diff --git a/gnuradio-core/src/lib/general/gri_lfsr.h b/gnuradio-core/src/lib/general/gri_lfsr.h index 090caab82..715da78a9 100644 --- a/gnuradio-core/src/lib/general/gri_lfsr.h +++ b/gnuradio-core/src/lib/general/gri_lfsr.h @@ -28,7 +28,7 @@ /*! * \brief Fibonacci Linear Feedback Shift Register using specified polynomial mask - * \ingroup math + * \ingroup misc * * Generates a maximal length pseudo-random sequence of length 2^degree-1 * diff --git a/gnuradio-core/src/lib/general/gri_lfsr_15_1_0.h b/gnuradio-core/src/lib/general/gri_lfsr_15_1_0.h index 5772edfb4..798f2faad 100644 --- a/gnuradio-core/src/lib/general/gri_lfsr_15_1_0.h +++ b/gnuradio-core/src/lib/general/gri_lfsr_15_1_0.h @@ -25,7 +25,7 @@ /*! * \brief Linear Feedback Shift Register using primitive polynomial x^15 + x + 1 - * \ingroup math + * \ingroup misc * * Generates a maximal length pseudo-random sequence of length 2^15 - 1 bits. */ diff --git a/gnuradio-core/src/lib/general/gri_lfsr_32k.h b/gnuradio-core/src/lib/general/gri_lfsr_32k.h index 3519cd278..33e7ae3a1 100644 --- a/gnuradio-core/src/lib/general/gri_lfsr_32k.h +++ b/gnuradio-core/src/lib/general/gri_lfsr_32k.h @@ -27,7 +27,7 @@ /*! * \brief generate pseudo-random sequence of length 32768 bits. - * \ingroup math + * \ingroup misc * * This is based on gri_lfsr_15_1_0 with an extra 0 added at the end * of the sequence. diff --git a/gnuradio-core/src/lib/gengen/gr_add_XX.h.t b/gnuradio-core/src/lib/gengen/gr_add_XX.h.t index 20c042c8e..91dd9196a 100644 --- a/gnuradio-core/src/lib/gengen/gr_add_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_add_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = sum (input_0, input_1, ...) - * \ingroup math + * \ingroup math_blk * * Add across all input streams. */ diff --git a/gnuradio-core/src/lib/gengen/gr_add_const_XX.h.t b/gnuradio-core/src/lib/gengen/gr_add_const_XX.h.t index 7096a4bf3..8e9884104 100644 --- a/gnuradio-core/src/lib/gengen/gr_add_const_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_add_const_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = input + constant - * \ingroup math + * \ingroup math_blk */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_add_const_vXX.h.t b/gnuradio-core/src/lib/gengen/gr_add_const_vXX.h.t index a72975c2b..33b6fc396 100755 --- a/gnuradio-core/src/lib/gengen/gr_add_const_vXX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_add_const_vXX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output vector = input vector + constant vector - * \ingroup math + * \ingroup math_blk */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_and_XX.h.t b/gnuradio-core/src/lib/gengen/gr_and_XX.h.t index 07abe8962..6152942dd 100644 --- a/gnuradio-core/src/lib/gengen/gr_and_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_and_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = input_0 & input_1 & , ... & input_N) - * \ingroup math + * \ingroup math_blk * * bitwise boolean and across all input streams. */ diff --git a/gnuradio-core/src/lib/gengen/gr_and_const_XX.h.t b/gnuradio-core/src/lib/gengen/gr_and_const_XX.h.t index c979b131c..3119611f1 100644 --- a/gnuradio-core/src/lib/gengen/gr_and_const_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_and_const_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output_N = input_N & value - * \ingroup math + * \ingroup math_blk * * bitwise boolean and of const to the data stream. */ diff --git a/gnuradio-core/src/lib/gengen/gr_chunks_to_symbols_XX.h.t b/gnuradio-core/src/lib/gengen/gr_chunks_to_symbols_XX.h.t index 10858261c..a5313d07d 100644 --- a/gnuradio-core/src/lib/gengen/gr_chunks_to_symbols_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_chunks_to_symbols_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief Map a stream of symbol indexes (unpacked bytes or shorts) to stream of float or complex onstellation points.in \p D dimensions (\p D = 1 by default) - * \ingroup converter + * \ingroup converter_blk * * input: stream of @I_TYPE@; output: stream of @O_TYPE@ * diff --git a/gnuradio-core/src/lib/gengen/gr_divide_XX.h.t b/gnuradio-core/src/lib/gengen/gr_divide_XX.h.t index c5b787161..a59497c8c 100644 --- a/gnuradio-core/src/lib/gengen/gr_divide_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_divide_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = input_0 / input_1 / input_x ...) - * \ingroup math + * \ingroup math_blk * * Divide across all input streams. */ diff --git a/gnuradio-core/src/lib/gengen/gr_integrate_XX.h.t b/gnuradio-core/src/lib/gengen/gr_integrate_XX.h.t index c8eca2d0a..01061ff21 100644 --- a/gnuradio-core/src/lib/gengen/gr_integrate_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_integrate_XX.h.t @@ -35,7 +35,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = sum(input[0]...input[n]) - * \ingroup math + * \ingroup math_blk * * Integrate successive samples in input stream and decimate */ diff --git a/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t b/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t index c0d0c8173..2441ca65b 100644 --- a/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t @@ -35,7 +35,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output is the moving sum of the last N samples, scaled by the scale factor - * \ingroup filter + * \ingroup filter_blk * * max_iter limits how long we go without flushing the accumulator * This is necessary to avoid numerical instability for float and complex. diff --git a/gnuradio-core/src/lib/gengen/gr_multiply_XX.h.t b/gnuradio-core/src/lib/gengen/gr_multiply_XX.h.t index f7cd9b138..cb4a0273d 100644 --- a/gnuradio-core/src/lib/gengen/gr_multiply_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_multiply_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = prod (input_0, input_1, ...) - * \ingroup math + * \ingroup math_blk * * Multiply across all input streams. */ diff --git a/gnuradio-core/src/lib/gengen/gr_multiply_const_XX.h.t b/gnuradio-core/src/lib/gengen/gr_multiply_const_XX.h.t index 6fda03c81..0c10185cc 100644 --- a/gnuradio-core/src/lib/gengen/gr_multiply_const_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_multiply_const_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = input * constant - * \ingroup math + * \ingroup math_blk */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_multiply_const_vXX.h.t b/gnuradio-core/src/lib/gengen/gr_multiply_const_vXX.h.t index c6368ac81..22334505a 100755 --- a/gnuradio-core/src/lib/gengen/gr_multiply_const_vXX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_multiply_const_vXX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output vector = input vector * constant vector (element-wise) - * \ingroup math + * \ingroup math_blk */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_mute_XX.h.t b/gnuradio-core/src/lib/gengen/gr_mute_XX.h.t index 6501e256f..5007787c4 100644 --- a/gnuradio-core/src/lib/gengen/gr_mute_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_mute_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = input or zero if muted. - * \ingroup level + * \ingroup level_blk */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_noise_source_X.h.t b/gnuradio-core/src/lib/gengen/gr_noise_source_X.h.t index 2eac56fa7..a920ce04a 100644 --- a/gnuradio-core/src/lib/gengen/gr_noise_source_X.h.t +++ b/gnuradio-core/src/lib/gengen/gr_noise_source_X.h.t @@ -38,7 +38,7 @@ gr_make_@BASE_NAME@ (gr_noise_type_t type, float ampl, long seed = 3021); /*! * \brief random number source - * \ingroup source + * \ingroup source_blk */ class @NAME@ : public gr_sync_block { friend @NAME@_sptr diff --git a/gnuradio-core/src/lib/gengen/gr_not_XX.h.t b/gnuradio-core/src/lib/gengen/gr_not_XX.h.t index 0a287683a..cf8d96ede 100644 --- a/gnuradio-core/src/lib/gengen/gr_not_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_not_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = ~input_0 - * \ingroup math + * \ingroup math_blk * * bitwise boolean not across input stream. */ diff --git a/gnuradio-core/src/lib/gengen/gr_or_XX.h.t b/gnuradio-core/src/lib/gengen/gr_or_XX.h.t index 027bbb586..3e02d9b1a 100644 --- a/gnuradio-core/src/lib/gengen/gr_or_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_or_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = input_0 | input_1 | , ... | input_N) - * \ingroup math + * \ingroup math_blk * * bitwise boolean or across all input streams. */ diff --git a/gnuradio-core/src/lib/gengen/gr_packed_to_unpacked_XX.h.t b/gnuradio-core/src/lib/gengen/gr_packed_to_unpacked_XX.h.t index 253bd2863..803098c0d 100644 --- a/gnuradio-core/src/lib/gengen/gr_packed_to_unpacked_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_packed_to_unpacked_XX.h.t @@ -36,7 +36,7 @@ gr_make_@BASE_NAME@ (unsigned int bits_per_chunk, gr_endianness_t endianness); /*! * \brief Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts. - * \ingroup converter + * \ingroup converter_blk * * input: stream of @I_TYPE@; output: stream of @O_TYPE@ * diff --git a/gnuradio-core/src/lib/gengen/gr_peak_detector_XX.h.t b/gnuradio-core/src/lib/gengen/gr_peak_detector_XX.h.t index 78a3e25b5..d6a8caf76 100644 --- a/gnuradio-core/src/lib/gengen/gr_peak_detector_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_peak_detector_XX.h.t @@ -37,7 +37,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief Detect the peak of a signal - * \ingroup level + * \ingroup level_blk * * If a peak is detected, this block outputs a 1, * or it outputs 0's. diff --git a/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t b/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t index e804775bd..b96487326 100644 --- a/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief sample and hold circuit - * \ingroup level + * \ingroup level_blk * * Samples the data stream (input stream 0) and holds the value * if the control signal is 1 (intput stream 1). diff --git a/gnuradio-core/src/lib/gengen/gr_sig_source_X.h.t b/gnuradio-core/src/lib/gengen/gr_sig_source_X.h.t index 2980ab805..9906d16ab 100644 --- a/gnuradio-core/src/lib/gengen/gr_sig_source_X.h.t +++ b/gnuradio-core/src/lib/gengen/gr_sig_source_X.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @NAME@_sptr; /*! * \brief signal generator with @TYPE@ output. - * \ingroup source + * \ingroup source_blk */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t b/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t index 2ba7023ca..a58d1f3b8 100644 --- a/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = input_0 - input_1 - ...) - * \ingroup math + * \ingroup math_blk * * Subtract across all input streams. */ diff --git a/gnuradio-core/src/lib/gengen/gr_unpacked_to_packed_XX.h.t b/gnuradio-core/src/lib/gengen/gr_unpacked_to_packed_XX.h.t index 2bac0ebc4..42d201093 100644 --- a/gnuradio-core/src/lib/gengen/gr_unpacked_to_packed_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_unpacked_to_packed_XX.h.t @@ -36,7 +36,7 @@ gr_make_@BASE_NAME@ (unsigned int bits_per_chunk, gr_endianness_t endianness); /*! * \brief Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts. - * \ingroup converter + * \ingroup converter_blk * * input: stream of @I_TYPE@; output: stream of @O_TYPE@ * diff --git a/gnuradio-core/src/lib/gengen/gr_vector_sink_X.h.t b/gnuradio-core/src/lib/gengen/gr_vector_sink_X.h.t index 70711d63c..b5fdf88fd 100644 --- a/gnuradio-core/src/lib/gengen/gr_vector_sink_X.h.t +++ b/gnuradio-core/src/lib/gengen/gr_vector_sink_X.h.t @@ -36,7 +36,7 @@ gr_make_@BASE_NAME@ (int vlen = 1); /*! * \brief @TYPE@ sink that writes to a vector - * \ingroup sink + * \ingroup sink_blk */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_vector_source_X.h.t b/gnuradio-core/src/lib/gengen/gr_vector_source_X.h.t index 88d34f362..63edcb61c 100644 --- a/gnuradio-core/src/lib/gengen/gr_vector_source_X.h.t +++ b/gnuradio-core/src/lib/gengen/gr_vector_source_X.h.t @@ -32,7 +32,7 @@ typedef boost::shared_ptr<@NAME@> @NAME@_sptr; /*! * \brief source of @TYPE@'s that gets its data from a vector - * \ingroup source + * \ingroup source_blk */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_xor_XX.h.t b/gnuradio-core/src/lib/gengen/gr_xor_XX.h.t index 82e899415..33d729450 100644 --- a/gnuradio-core/src/lib/gengen/gr_xor_XX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_xor_XX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = input_0 ^ input_1 ^ , ... ^ input_N) - * \ingroup math + * \ingroup math_blk * * bitwise boolean xor across all input streams. */ diff --git a/gnuradio-core/src/lib/io/gr_file_descriptor_sink.h b/gnuradio-core/src/lib/io/gr_file_descriptor_sink.h index 4b5ceff31..fa8fa3f05 100644 --- a/gnuradio-core/src/lib/io/gr_file_descriptor_sink.h +++ b/gnuradio-core/src/lib/io/gr_file_descriptor_sink.h @@ -32,7 +32,7 @@ gr_file_descriptor_sink_sptr gr_make_file_descriptor_sink (size_t itemsize, int /*! * \brief Write stream to file descriptor. - * \ingroup sink + * \ingroup sink_blk */ class gr_file_descriptor_sink : public gr_sync_block diff --git a/gnuradio-core/src/lib/io/gr_file_descriptor_source.h b/gnuradio-core/src/lib/io/gr_file_descriptor_source.h index b233580c6..a9f117286 100644 --- a/gnuradio-core/src/lib/io/gr_file_descriptor_source.h +++ b/gnuradio-core/src/lib/io/gr_file_descriptor_source.h @@ -33,7 +33,7 @@ gr_make_file_descriptor_source (size_t itemsize, int fd, bool repeat = false); /*! * \brief Read stream from file descriptor. - * \ingroup source + * \ingroup source_blk */ class gr_file_descriptor_source : public gr_sync_block diff --git a/gnuradio-core/src/lib/io/gr_file_sink.h b/gnuradio-core/src/lib/io/gr_file_sink.h index 16cd4befc..b9ad06cd6 100644 --- a/gnuradio-core/src/lib/io/gr_file_sink.h +++ b/gnuradio-core/src/lib/io/gr_file_sink.h @@ -33,7 +33,7 @@ gr_file_sink_sptr gr_make_file_sink(size_t itemsize, const char *filename); /*! * \brief Write stream to file. - * \ingroup sink + * \ingroup sink_blk */ class gr_file_sink : public gr_sync_block, public gr_file_sink_base diff --git a/gnuradio-core/src/lib/io/gr_file_source.h b/gnuradio-core/src/lib/io/gr_file_source.h index bf490040b..5f5c2564e 100644 --- a/gnuradio-core/src/lib/io/gr_file_source.h +++ b/gnuradio-core/src/lib/io/gr_file_source.h @@ -33,7 +33,7 @@ gr_make_file_source (size_t itemsize, const char *filename, bool repeat = false) /*! * \brief Read stream from file - * \ingroup source + * \ingroup source_blk */ class gr_file_source : public gr_sync_block diff --git a/gnuradio-core/src/lib/io/gr_histo_sink_f.h b/gnuradio-core/src/lib/io/gr_histo_sink_f.h index ae34d302d..640398c60 100644 --- a/gnuradio-core/src/lib/io/gr_histo_sink_f.h +++ b/gnuradio-core/src/lib/io/gr_histo_sink_f.h @@ -34,7 +34,7 @@ gr_histo_sink_f_sptr gr_make_histo_sink_f (gr_msg_queue_sptr msgq); /*! * \brief Histogram module. - * \ingroup sink + * \ingroup sink_blk */ class gr_histo_sink_f : public gr_sync_block { diff --git a/gnuradio-core/src/lib/io/gr_message_sink.h b/gnuradio-core/src/lib/io/gr_message_sink.h index 9126358cb..5f1e5f91f 100644 --- a/gnuradio-core/src/lib/io/gr_message_sink.h +++ b/gnuradio-core/src/lib/io/gr_message_sink.h @@ -36,7 +36,7 @@ gr_message_sink_sptr gr_make_message_sink (size_t itemsize, /*! * \brief Gather received items into messages and insert into msgq - * \ingroup sink + * \ingroup sink_blk */ class gr_message_sink : public gr_sync_block { diff --git a/gnuradio-core/src/lib/io/gr_message_source.h b/gnuradio-core/src/lib/io/gr_message_source.h index 4a1378c2b..5a5c6a5d8 100644 --- a/gnuradio-core/src/lib/io/gr_message_source.h +++ b/gnuradio-core/src/lib/io/gr_message_source.h @@ -34,7 +34,7 @@ gr_message_source_sptr gr_make_message_source (size_t itemsize, int msgq_limit=0 /*! * \brief Turn received messages into a stream - * \ingroup source + * \ingroup source_blk */ class gr_message_source : public gr_sync_block { diff --git a/gnuradio-core/src/lib/io/gr_oscope_sink_f.h b/gnuradio-core/src/lib/io/gr_oscope_sink_f.h index 22d145c54..1a8022b89 100644 --- a/gnuradio-core/src/lib/io/gr_oscope_sink_f.h +++ b/gnuradio-core/src/lib/io/gr_oscope_sink_f.h @@ -34,7 +34,7 @@ gr_oscope_sink_f_sptr gr_make_oscope_sink_f (double sampling_rate, gr_msg_queue_ /*! * \brief Building block for python oscilloscope module. - * \ingroup sink + * \ingroup sink_blk * * Accepts multiple float streams. */ diff --git a/gnuradio-core/src/lib/io/gr_oscope_sink_x.h b/gnuradio-core/src/lib/io/gr_oscope_sink_x.h index 408979eb6..62cf65100 100644 --- a/gnuradio-core/src/lib/io/gr_oscope_sink_x.h +++ b/gnuradio-core/src/lib/io/gr_oscope_sink_x.h @@ -30,7 +30,7 @@ class gr_oscope_guts; /*! * \brief Abstract class for python oscilloscope module. - * \ingroup sink + * \ingroup sink_blk * * Don't instantiate this. Use gr_oscope_sink_f or gr_oscope_sink_c instead. */ diff --git a/gnuradio-core/src/lib/io/gr_udp_sink.h b/gnuradio-core/src/lib/io/gr_udp_sink.h index 99f1b2935..13b2befc9 100644 --- a/gnuradio-core/src/lib/io/gr_udp_sink.h +++ b/gnuradio-core/src/lib/io/gr_udp_sink.h @@ -47,7 +47,7 @@ gr_make_udp_sink (size_t itemsize, /*! * \brief Write stream to an UDP socket. - * \ingroup sink + * \ingroup sink_blk * * \param itemsize The size (in bytes) of the item datatype * \param src The source address as either the host name or the 'numbers-and-dots' diff --git a/gnuradio-core/src/lib/io/gr_udp_source.h b/gnuradio-core/src/lib/io/gr_udp_source.h index 049740159..afc41a45a 100644 --- a/gnuradio-core/src/lib/io/gr_udp_source.h +++ b/gnuradio-core/src/lib/io/gr_udp_source.h @@ -44,7 +44,7 @@ gr_udp_source_sptr gr_make_udp_source(size_t itemsize, const char *src, /*! * \brief Read stream from an UDP socket. - * \ingroup sink + * \ingroup source_blk * * \param itemsize The size (in bytes) of the item datatype * \param src The source address as either the host name or the 'numbers-and-dots' diff --git a/gnuradio-core/src/lib/io/gr_wavfile_sink.h b/gnuradio-core/src/lib/io/gr_wavfile_sink.h index 9429165f6..fd1d0bf6f 100644 --- a/gnuradio-core/src/lib/io/gr_wavfile_sink.h +++ b/gnuradio-core/src/lib/io/gr_wavfile_sink.h @@ -48,7 +48,7 @@ gr_make_wavfile_sink (const char *filename, * Values are within [-1;1]. * Check gr_make_wavfile_source() for extra info. * - * \ingroup sink + * \ingroup sink_blk */ class gr_wavfile_sink : public gr_sync_block { diff --git a/gnuradio-core/src/lib/io/gr_wavfile_source.h b/gnuradio-core/src/lib/io/gr_wavfile_source.h index d737b441b..0c663f0a0 100644 --- a/gnuradio-core/src/lib/io/gr_wavfile_source.h +++ b/gnuradio-core/src/lib/io/gr_wavfile_source.h @@ -37,7 +37,7 @@ gr_make_wavfile_source (const char *filename, bool repeat = false); * Unless otherwise called, values are within [-1;1]. * Check gr_make_wavfile_source() for extra info. * - * \ingroup source + * \ingroup source_blk */ class gr_wavfile_source : public gr_sync_block diff --git a/gnuradio-core/src/lib/runtime/gr_basic_block.h b/gnuradio-core/src/lib/runtime/gr_basic_block.h index 78297d3f0..faaba1c83 100644 --- a/gnuradio-core/src/lib/runtime/gr_basic_block.h +++ b/gnuradio-core/src/lib/runtime/gr_basic_block.h @@ -30,7 +30,7 @@ /*! * \brief The abstract base class for all signal processing blocks. - * \ingroup base + * \ingroup internal * * Basic blocks are the bare abstraction of an entity that has a name * and a set of inputs and outputs. These are never instantiated diff --git a/gnuradio-core/src/lib/runtime/gr_block.h b/gnuradio-core/src/lib/runtime/gr_block.h index 437b610b4..354695c0b 100644 --- a/gnuradio-core/src/lib/runtime/gr_block.h +++ b/gnuradio-core/src/lib/runtime/gr_block.h @@ -27,7 +27,7 @@ /*! * \brief The abstract base class for all 'terminal' processing blocks. - * \ingroup base + * \ingroup base_blk * * A signal processing flow is constructed by creating a tree of * hierarchical blocks, which at any level may also contain terminal nodes diff --git a/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h b/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h index 673c4df16..8e9834337 100644 --- a/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h +++ b/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h @@ -33,8 +33,7 @@ gr_flat_flowgraph_sptr gr_make_flat_flowgraph(); /*! *\brief Class specializing gr_flat_flowgraph that has all nodes * as gr_blocks, with no hierarchy - * \ingroup base - * + * \ingroup internal */ class gr_flat_flowgraph : public gr_flowgraph { diff --git a/gnuradio-core/src/lib/runtime/gr_flowgraph.h b/gnuradio-core/src/lib/runtime/gr_flowgraph.h index fc407e72b..8e988506b 100644 --- a/gnuradio-core/src/lib/runtime/gr_flowgraph.h +++ b/gnuradio-core/src/lib/runtime/gr_flowgraph.h @@ -27,9 +27,8 @@ #include <iostream> /*! - *\brief Class representing a specific input or output graph endpoint + * \brief Class representing a specific input or output graph endpoint * \ingroup internal - * */ class gr_endpoint { @@ -85,8 +84,8 @@ typedef std::vector<gr_edge>::iterator gr_edge_viter_t; gr_flowgraph_sptr gr_make_flowgraph(); /*! - *\brief Class representing a directed, acyclic graph of basic blocks - * + * \brief Class representing a directed, acyclic graph of basic blocks + * \ingroup internal */ class gr_flowgraph { diff --git a/gnuradio-core/src/lib/runtime/gr_hier_block2.h b/gnuradio-core/src/lib/runtime/gr_hier_block2.h index 52b9bff96..f0bbe4e65 100644 --- a/gnuradio-core/src/lib/runtime/gr_hier_block2.h +++ b/gnuradio-core/src/lib/runtime/gr_hier_block2.h @@ -36,7 +36,8 @@ class gr_hier_block2_detail; /*! * \brief gr_hier_block2 - Hierarchical container class for gr_block's - * \ingroup internal + * \ingroup container_blk + * \ingroup base_blk * */ class gr_hier_block2 : public gr_basic_block diff --git a/gnuradio-core/src/lib/runtime/gr_hier_block2_detail.h b/gnuradio-core/src/lib/runtime/gr_hier_block2_detail.h index 0e1f89fb4..6f5384e5a 100644 --- a/gnuradio-core/src/lib/runtime/gr_hier_block2_detail.h +++ b/gnuradio-core/src/lib/runtime/gr_hier_block2_detail.h @@ -26,6 +26,9 @@ #include <gr_flat_flowgraph.h> #include <boost/utility.hpp> +/*! + * \ingroup internal + */ class gr_hier_block2_detail : boost::noncopyable { public: diff --git a/gnuradio-core/src/lib/runtime/gr_io_signature.h b/gnuradio-core/src/lib/runtime/gr_io_signature.h index bf71dea57..8c327259c 100644 --- a/gnuradio-core/src/lib/runtime/gr_io_signature.h +++ b/gnuradio-core/src/lib/runtime/gr_io_signature.h @@ -85,6 +85,7 @@ gr_make_io_signaturev(int min_streams, int max_streams, /*! * \brief i/o signature for input and output ports. + * \brief misc */ class gr_io_signature { int d_min_streams; diff --git a/gnuradio-core/src/lib/runtime/gr_sync_block.h b/gnuradio-core/src/lib/runtime/gr_sync_block.h index c7f7d4df3..3a5d89d19 100644 --- a/gnuradio-core/src/lib/runtime/gr_sync_block.h +++ b/gnuradio-core/src/lib/runtime/gr_sync_block.h @@ -27,7 +27,7 @@ /*! * \brief synchronous 1:1 input to output with history - * \ingroup internal + * \ingroup base_blk * * Override work to provide the signal processing implementation. */ diff --git a/gnuradio-core/src/lib/runtime/gr_sync_decimator.h b/gnuradio-core/src/lib/runtime/gr_sync_decimator.h index 1482ecc00..12cd54195 100644 --- a/gnuradio-core/src/lib/runtime/gr_sync_decimator.h +++ b/gnuradio-core/src/lib/runtime/gr_sync_decimator.h @@ -27,7 +27,7 @@ /*! * \brief synchronous N:1 input to output with history - * \ingroup internal + * \ingroup base_blk * * Override work to provide the signal processing implementation. */ diff --git a/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h b/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h index 87e718cca..0363bc55c 100644 --- a/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h +++ b/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h @@ -27,7 +27,7 @@ /*! * \brief synchronous 1:N input to output with history - * \ingroup internal + * \ingroup base_blk * * Override work to provide the signal processing implementation. */ diff --git a/gnuradio-core/src/lib/runtime/gr_top_block.h b/gnuradio-core/src/lib/runtime/gr_top_block.h index bfe799c84..8052954e3 100644 --- a/gnuradio-core/src/lib/runtime/gr_top_block.h +++ b/gnuradio-core/src/lib/runtime/gr_top_block.h @@ -31,7 +31,7 @@ gr_top_block_sptr gr_make_top_block(const std::string &name); /*! *\brief Top-level hierarchical block representing a flowgraph - * \ingroup internal + * \ingroup container_blk * */ class gr_top_block : public gr_hier_block2 diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h index 0d4f45832..a73a1559c 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h @@ -27,7 +27,7 @@ /*! * \brief abstract class to implement doubly mapped virtual memory circular buffers - * \ingroup base + * \ingroup internal */ class gr_vmcircbuf { protected: diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h index 2bb7bb16f..9276ae98b 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h @@ -30,7 +30,7 @@ #endif /*! * \brief concrete class to implement circular buffers with mmap and shm_open - * \ingroup base + * \ingroup internal */ class gr_vmcircbuf_createfilemapping : public gr_vmcircbuf { diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h index 7e628fa59..238f44414 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h @@ -27,7 +27,7 @@ /*! * \brief concrete class to implement circular buffers with mmap and shm_open - * \ingroup base + * \ingroup internal */ class gr_vmcircbuf_mmap_shm_open : public gr_vmcircbuf { public: diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h index da91d2f02..e5be52768 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h @@ -27,7 +27,7 @@ /*! * \brief concrete class to implement circular buffers with mmap and shm_open - * \ingroup base + * \ingroup internal */ class gr_vmcircbuf_mmap_tmpfile : public gr_vmcircbuf { public: diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h index ffc74918e..cc87f8fe6 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h @@ -27,7 +27,7 @@ /*! * \brief concrete class to implement circular buffers with mmap and shm_open - * \ingroup base + * \ingroup internal */ class gr_vmcircbuf_sysv_shm : public gr_vmcircbuf { public: |