diff options
Diffstat (limited to 'gnuradio-core/src')
165 files changed, 208 insertions, 97 deletions
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 a23965c7d..2e0240ca0 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h @@ -26,6 +26,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_ccc + * \ingroup filter * * 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 de5bc5bed..637310ce4 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h @@ -27,6 +27,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_ccf + * \ingroup filter * * 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 2a50d0ffb..1da73d741 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h +++ b/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h @@ -27,6 +27,7 @@ /*! * \brief 3DNow! version of gr_fir_ccf + * \ingroup filter */ class gr_fir_ccf_3dnow : public gr_fir_ccf_simd { @@ -37,6 +38,7 @@ public: /*! * \brief SSE version of gr_fir_ccf + * \ingroup filter */ 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 fc98ad19b..e8815e987 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h @@ -27,6 +27,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_fcc + * \ingroup filter * * 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 3a6433787..02d75fa46 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h @@ -27,6 +27,7 @@ /*! * \brief 3DNow! version of gr_fir_fcc + * \ingroup filter */ class gr_fir_fcc_3dnow : public gr_fir_fcc_simd { @@ -37,6 +38,7 @@ public: /*! * \brief SSE version of gr_fir_fcc + * \ingroup filter */ 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 eac5cc921..a3bb38366 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h @@ -26,6 +26,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_fff + * \ingroup filter * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. 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 3e802d2a3..6a42327e0 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h @@ -26,6 +26,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_fsf + * \ingroup filter * * 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 a95344a9e..1f4501ed0 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h @@ -27,6 +27,7 @@ /*! * \brief 3DNow! version of gr_fir_fsf + * \ingroup filter */ class gr_fir_fsf_3dnow : public gr_fir_fsf_simd { @@ -37,6 +38,7 @@ public: /*! * \brief SSE version of gr_fir_fsf + * \ingroup filter */ 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 01b4e6cb4..6bd7f1765 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h @@ -27,6 +27,7 @@ /*! * \brief common base class for SIMD versions of gr_fir_scc + * \ingroup filter * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. diff --git a/gnuradio-core/src/lib/filter/gr_goertzel_fc.h b/gnuradio-core/src/lib/filter/gr_goertzel_fc.h index 16b5252e8..60e0cc17f 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 filter + * \ingroup dft */ class gr_goertzel_fc : public gr_sync_decimator { diff --git a/gnuradio-core/src/lib/filter/gr_single_pole_avg.h b/gnuradio-core/src/lib/filter/gr_single_pole_avg.h index 0995eee39..91324fc50 100644 --- a/gnuradio-core/src/lib/filter/gr_single_pole_avg.h +++ b/gnuradio-core/src/lib/filter/gr_single_pole_avg.h @@ -26,6 +26,7 @@ /*! * \brief class template for single pole moving average filter + * \ingroup filter */ template<class o_type, class i_type, class tap_type> class gr_single_pole_avg { diff --git a/gnuradio-core/src/lib/filter/gri_goertzel.h b/gnuradio-core/src/lib/filter/gri_goertzel.h index 1d20a920a..a42ab08cd 100644 --- a/gnuradio-core/src/lib/filter/gri_goertzel.h +++ b/gnuradio-core/src/lib/filter/gri_goertzel.h @@ -26,7 +26,8 @@ #include <gr_types.h> /*! - * \brief implements Goertzel single-bin DFT calculation + * \brief Implements Goertzel single-bin DFT calculation + * \ingroup dft */ class gri_goertzel 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 0cd44529e..60c0d4bc6 100644 --- a/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h +++ b/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h @@ -28,6 +28,7 @@ class gr_fir_fff; /*! * \brief Compute intermediate samples between signal samples x(k*Ts) + * \ingroup filter * * 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 687498c3b..6f94c7c80 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,6 +29,7 @@ class gr_fir_ccf; /*! * \brief Compute intermediate samples between signal samples x(k*Ts) + * \ingroup filter * * 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 b2fbbfc82..e27359e70 100644 --- a/gnuradio-core/src/lib/general/gr_agc2_cc.h +++ b/gnuradio-core/src/lib/general/gr_agc2_cc.h @@ -34,6 +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 * * 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 8ce53f347..61ebac1f1 100644 --- a/gnuradio-core/src/lib/general/gr_agc2_ff.h +++ b/gnuradio-core/src/lib/general/gr_agc2_ff.h @@ -34,6 +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 * 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 559571615..56bc8aaa4 100644 --- a/gnuradio-core/src/lib/general/gr_agc_cc.h +++ b/gnuradio-core/src/lib/general/gr_agc_cc.h @@ -33,6 +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 * * 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 1021d07b2..45872a2a5 100644 --- a/gnuradio-core/src/lib/general/gr_agc_ff.h +++ b/gnuradio-core/src/lib/general/gr_agc_ff.h @@ -34,6 +34,7 @@ gr_make_agc_ff (float rate = 1e-4, float reference = 1.0, /*! * \brief high performance Automatic Gain Control class + * \ingroup level * * Power is approximated by absolute value */ diff --git a/gnuradio-core/src/lib/general/gr_align_on_samplenumbers_ss.h b/gnuradio-core/src/lib/general/gr_align_on_samplenumbers_ss.h index 45965e4f4..5038e168b 100644 --- a/gnuradio-core/src/lib/general/gr_align_on_samplenumbers_ss.h +++ b/gnuradio-core/src/lib/general/gr_align_on_samplenumbers_ss.h @@ -25,13 +25,9 @@ #include <gr_block.h> -class gr_align_on_samplenumbers_ss; -typedef boost::shared_ptr<gr_align_on_samplenumbers_ss> gr_align_on_samplenumbers_ss_sptr; - -gr_align_on_samplenumbers_ss_sptr gr_make_align_on_samplenumbers_ss (int nchan=2, int align_interval=128); - /*! * \brief align several complex short (interleaved short) input channels with corresponding unsigned 32 bit sample_counters (provided as interleaved 16 bit values) + * \ingroup misc * \param number of complex_short input channels (including the 32 bit counting channel) * \param align_interval is after how much samples (minimally) the sample-alignement is refreshed. Default is 128. * A bigger value means less processing power but also requests more buffer space, which has a maximum. @@ -46,6 +42,12 @@ gr_align_on_samplenumbers_ss_sptr gr_make_align_on_samplenumbers_ss (int nchan=2 * This means that the first complex_short channel on every input is an interleaved 32 bit counter. * The samples are aligned by dropping samples untill the samplenumbers match. */ +class gr_align_on_samplenumbers_ss; +typedef boost::shared_ptr<gr_align_on_samplenumbers_ss> gr_align_on_samplenumbers_ss_sptr; + +gr_align_on_samplenumbers_ss_sptr gr_make_align_on_samplenumbers_ss (int nchan=2, int align_interval=128); + + class gr_align_on_samplenumbers_ss : public gr_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 9876f0c54..267a07147 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 block + * \ingroup converter * * 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 a9abaa1e3..47596c934 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 block + * \ingroup converter * * input: stream of bytes; output: stream of float * 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 866732286..e4819ef60 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 block + * \ingroup clock * * 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 a121fe821..582685cc5 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 block + * \ingroup clock * * This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer. * diff --git a/gnuradio-core/src/lib/general/gr_conjugate_cc.h b/gnuradio-core/src/lib/general/gr_conjugate_cc.h index 6228d8783..29dd95e60 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 block + * \ingroup math */ 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 a2b0d2346..52c397799 100644 --- a/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h +++ b/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h @@ -33,7 +33,11 @@ gr_constellation_decoder_cb_sptr gr_make_constellation_decoder_cb (const std::vector<gr_complex> &sym_position, const std::vector<unsigned char> &sym_value_out); - +/*! + * \brief Constellation Decoder + * \ingroup coding + * + */ 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 960bda141..4dd3a78a1 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 block + * \ingroup synch * * 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 3c43785ba..ff40e6608 100644 --- a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h +++ b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h @@ -28,10 +28,9 @@ #include <stdexcept> #include <fstream> -class gr_costas_loop_cc; -typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr; /*! \brief A Costas loop carrier recovery module. + * \ingroup clock * * The Costas loop locks to the center frequency of a signal and * downconverts it to baseband. The second (order=2) order loop is @@ -54,6 +53,10 @@ typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr; * \param min_freq the minimum frequency deviation (normalized frequency) the loop can handle * \param order the loop order, either 2 or 4 */ +class gr_costas_loop_cc; +typedef boost::shared_ptr<gr_costas_loop_cc> gr_costas_loop_cc_sptr; + + gr_costas_loop_cc_sptr gr_make_costas_loop_cc (float alpha, float beta, float max_freq, float min_freq, @@ -63,7 +66,7 @@ gr_make_costas_loop_cc (float alpha, float beta, /*! * \brief Carrier tracking PLL for QPSK - * \ingroup block + * \ingroup clock * 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_crc32.h b/gnuradio-core/src/lib/general/gr_crc32.h index b0c746acf..87a8d15f2 100644 --- a/gnuradio-core/src/lib/general/gr_crc32.h +++ b/gnuradio-core/src/lib/general/gr_crc32.h @@ -28,6 +28,7 @@ /*! * \brief update running CRC-32 + * \ingroup misc * * Update a running CRC with the bytes buf[0..len-1] The CRC should be * initialized to all 1's, and the transmitted value is the 1's 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 807b83fe9..7b708867b 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 block + * \ingroup level */ 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 b8a2bd83b..3153d5b05 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,6 +37,7 @@ gr_make_dd_mpsk_sync_cc (float alpha, float beta, /*! * \brief Decision directed M-PSK synchronous demod + * \ingroup clock * 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 af9dd3f0a..714b9e1df 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 block + * \ingroup misc */ 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 aebf4604a..aa25a5773 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 block + * \ingroup misc */ 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 ec47d8b61..ddb519d66 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 block + * \ingroup coding * * 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 dbf161015..9cc13313f 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 block + * \ingroup coding * * Differential encoder */ diff --git a/gnuradio-core/src/lib/general/gr_diff_phasor_cc.h b/gnuradio-core/src/lib/general/gr_diff_phasor_cc.h index 4be7060eb..1070ba183 100644 --- a/gnuradio-core/src/lib/general/gr_diff_phasor_cc.h +++ b/gnuradio-core/src/lib/general/gr_diff_phasor_cc.h @@ -25,6 +25,10 @@ #include <gr_sync_block.h> +/*! + * \brief Please fix my documentation! + * \ingroup misc + */ class gr_diff_phasor_cc; typedef boost::shared_ptr<gr_diff_phasor_cc> gr_diff_phasor_cc_sptr; diff --git a/gnuradio-core/src/lib/general/gr_dpll_bb.h b/gnuradio-core/src/lib/general/gr_dpll_bb.h index 75579d191..e1e60c1b1 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 block + * \ingroup level * * 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 6541c4fb3..7c64a577e 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 block + * \ingroup coding * * 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 block + * \ingroup coding * * 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 71694fdb1..b7e46bd1e 100644 --- a/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h +++ b/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h @@ -33,6 +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 */ class gr_feedforward_agc_cc : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_feval.h b/gnuradio-core/src/lib/general/gr_feval.h index bf774fa58..cc4209af0 100644 --- a/gnuradio-core/src/lib/general/gr_feval.h +++ b/gnuradio-core/src/lib/general/gr_feval.h @@ -26,6 +26,7 @@ /*! * \brief base class for evaluating a function: double -> double + * \ingroup misc * * This class is designed to be subclassed in Python or C++ * and is callable from both places. It uses SWIG's @@ -53,6 +54,7 @@ public: /*! * \brief base class for evaluating a function: complex -> complex + * \ingroup misc * * This class is designed to be subclassed in Python or C++ * and is callable from both places. It uses SWIG's @@ -80,6 +82,7 @@ public: /*! * \brief base class for evaluating a function: long -> long + * \ingroup misc * * This class is designed to be subclassed in Python or C++ * and is callable from both places. It uses SWIG's @@ -107,6 +110,7 @@ public: /*! * \brief base class for evaluating a function: void -> void + * \ingroup misc * * This class is designed to be subclassed in Python or C++ * and is callable from both places. It uses SWIG's diff --git a/gnuradio-core/src/lib/general/gr_fft_vcc.h b/gnuradio-core/src/lib/general/gr_fft_vcc.h index 10b912a31..71fe17353 100644 --- a/gnuradio-core/src/lib/general/gr_fft_vcc.h +++ b/gnuradio-core/src/lib/general/gr_fft_vcc.h @@ -35,7 +35,7 @@ gr_make_fft_vcc (int fft_size, bool forward, const std::vector<float> window, bo /*! * \brief Compute forward or reverse FFT. complex vector in / complex vector out. - * \ingroup block + * \ingroup dft */ class gr_fft_vcc : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_fft_vfc.h b/gnuradio-core/src/lib/general/gr_fft_vfc.h index d9f7d35aa..e7f71de8b 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 block + * \ingroup dft */ class gr_fft_vfc : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_firdes.h b/gnuradio-core/src/lib/general/gr_firdes.h index 2a1d6e70a..f920398ad 100644 --- a/gnuradio-core/src/lib/general/gr_firdes.h +++ b/gnuradio-core/src/lib/general/gr_firdes.h @@ -29,6 +29,7 @@ /*! * \brief Finite Impulse Response (FIR) filter design functions. + * \ingroup filter_design */ class gr_firdes { 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 9286bc49d..c8512a305 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 block + * \ingroup modulation * * 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 e41577fe7..da733cdae 100644 --- a/gnuradio-core/src/lib/general/gr_fxpt.h +++ b/gnuradio-core/src/lib/general/gr_fxpt.h @@ -26,6 +26,7 @@ /*! * \brief fixed point sine and cosine and friends. + * \ingroup math * * fixed pt radians * --------- -------- diff --git a/gnuradio-core/src/lib/general/gr_fxpt_nco.h b/gnuradio-core/src/lib/general/gr_fxpt_nco.h index 879c5ab4c..6487a5f48 100644 --- a/gnuradio-core/src/lib/general/gr_fxpt_nco.h +++ b/gnuradio-core/src/lib/general/gr_fxpt_nco.h @@ -27,6 +27,7 @@ /*! * \brief Numerically Controlled Oscillator (NCO) + * \ingroup misc */ class gr_fxpt_nco { gr_int32 d_phase; diff --git a/gnuradio-core/src/lib/general/gr_fxpt_vco.h b/gnuradio-core/src/lib/general/gr_fxpt_vco.h index 00dd855a0..1ff968b79 100644 --- a/gnuradio-core/src/lib/general/gr_fxpt_vco.h +++ b/gnuradio-core/src/lib/general/gr_fxpt_vco.h @@ -27,6 +27,7 @@ /*! * \brief Voltage Controlled Oscillator (VCO) + * \ingroup misc */ class gr_fxpt_vco { gr_int32 d_phase; diff --git a/gnuradio-core/src/lib/general/gr_head.h b/gnuradio-core/src/lib/general/gr_head.h index 87f865d2d..97104b890 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 block + * \ingroup flow * * 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 6f77c470a..d8901f92b 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 block + * \ingroup misc */ class gr_interleave : public gr_sync_interpolator { 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 1cc145a90..0ed9d0bca 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 block + * \ingroup misc */ 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 9ae5cda41..b56a2f4c5 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 block + * \ingroup misc * * 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_lms_dfe_cc.h b/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h index 6f18816bd..10d862f0d 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 block + * \ingroup misc */ 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 8c1f3f9c3..16e3a69ec 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 block + * \ingroup misc */ 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 041ce6ed6..a37f2fc2f 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 block + * \ingroup misc */ 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 e5173eceb..36392116e 100644 --- a/gnuradio-core/src/lib/general/gr_math.h +++ b/gnuradio-core/src/lib/general/gr_math.h @@ -44,6 +44,7 @@ int gr_signbit (double x); /*! * \brief Fast arc tangent using table lookup and linear interpolation + * \ingroup math * * \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 cddb697ac..b3ce9cea2 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 block + * \ingroup synch * * 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_nco.h b/gnuradio-core/src/lib/general/gr_nco.h index b8da597c6..0e740a317 100644 --- a/gnuradio-core/src/lib/general/gr_nco.h +++ b/gnuradio-core/src/lib/general/gr_nco.h @@ -30,6 +30,7 @@ /*! * \brief base class template for Numerically Controlled Oscillator (NCO) + * \ingroup misc */ diff --git a/gnuradio-core/src/lib/general/gr_nlog10_ff.h b/gnuradio-core/src/lib/general/gr_nlog10_ff.h index 6e093023c..352685ecd 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 block + * \ingroup math */ 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 72575fdb5..20d66d17e 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 block + * \ingroup misc */ class gr_nop : public gr_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 f2927949b..0d8764cee 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h @@ -37,6 +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 */ class gr_ofdm_bpsk_demapper : public gr_block diff --git a/gnuradio-core/src/lib/general/gr_ofdm_bpsk_mapper.h b/gnuradio-core/src/lib/general/gr_ofdm_bpsk_mapper.h index 6c12f76f5..9142228f1 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_bpsk_mapper.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_bpsk_mapper.h @@ -39,6 +39,7 @@ gr_make_ofdm_bpsk_mapper (unsigned msgq_limit, * \brief take a message in and map to a vector of complex * constellation points suitable for IFFT input to be used in an ofdm * modulator. Simple BPSK version. + * \ingroup modulation */ class gr_ofdm_bpsk_mapper : public gr_sync_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 37df233f3..d34665a9a 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 block + * \ingroup synch */ 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 944f04314..42295cddb 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h @@ -36,6 +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 */ 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 af63f3e4c..9e4420f1a 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. - * \inblock blocks + * \ingroup demodulation * * 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 904373bba..cc3d67bd5 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 * 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 05ec96f4b..0b6b6ae02 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h @@ -34,6 +34,7 @@ gr_make_ofdm_insert_preamble(int fft_length, /*! * \brief insert "pre-modulated" preamble symbols before each payload. + * \ingroup synch * * <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 a9b676a3c..010603b9c 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h @@ -38,6 +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 * */ diff --git a/gnuradio-core/src/lib/general/gr_ofdm_qam_mapper.h b/gnuradio-core/src/lib/general/gr_ofdm_qam_mapper.h index a4f707cbc..7be03b41f 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_qam_mapper.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_qam_mapper.h @@ -40,6 +40,7 @@ gr_make_ofdm_qam_mapper (unsigned msgq_limit, * \brief take a message in and map to a vector of complex * constellation points suitable for IFFT input to be used in an ofdm * modulator. Simple QAM version. + * \ingroup modulation */ class gr_ofdm_qam_mapper : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_ofdm_qpsk_mapper.h b/gnuradio-core/src/lib/general/gr_ofdm_qpsk_mapper.h index bb1f8cd1f..aa424ad65 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_qpsk_mapper.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_qpsk_mapper.h @@ -39,6 +39,7 @@ gr_make_ofdm_qpsk_mapper (unsigned msgq_limit, * \brief take a message in and map to a vector of complex * constellation points suitable for IFFT input to be used in an ofdm * modulator. Simple QPSK version. + * \ingroup modulation */ class gr_ofdm_qpsk_mapper : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_ofdm_sampler.h b/gnuradio-core/src/lib/general/gr_ofdm_sampler.h index 9f72fbbb6..de6be28bc 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_sampler.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_sampler.h @@ -32,7 +32,8 @@ gr_ofdm_sampler_sptr gr_make_ofdm_sampler (unsigned int fft_length, unsigned int symbol_length); /*! - * \brief does the rest of the OFDM stuff (fixme) + * \brief does the rest of the OFDM stuff + * \ingroup misc */ class gr_ofdm_sampler : public gr_block 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 3013c0c5e..239b463d8 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 block + * \ingroup misc * * Anntenas are arranged like this: * 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 e20c6c022..85bf577e0 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 block + * \ingroup level * * 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 b9c1f8de7..828edf62b 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 block + * \ingroup modulation * 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 ae05dee5e..2033fe177 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 block + * \ingroup clock * * 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 1d8e209e4..2235a6904 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 block + * \ingroup clock * * 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 fa8d4769d..6f8370fe9 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 block + * \ingroup clock * * 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 56481c50a..12aad470d 100644 --- a/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h +++ b/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h @@ -34,6 +34,7 @@ gr_make_pn_correlator_cc(int degree, int mask=0, int seed=1); /*! * \brief PN code sequential search correlator * + * \ingroup synch * 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_prefs.h b/gnuradio-core/src/lib/general/gr_prefs.h index 4a2caa462..4396d727c 100644 --- a/gnuradio-core/src/lib/general/gr_prefs.h +++ b/gnuradio-core/src/lib/general/gr_prefs.h @@ -26,6 +26,7 @@ /*! * \brief Base class for representing user preferences a la windows INI files. + * \ingroup misc * * The real implementation is in Python, and is accessable from C++ * via the magic of SWIG directors. 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 97d91bfed..2628b5687 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 block + * \ingroup level */ 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 25fed7d1b..229ce595e 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 block + * \ingroup level */ 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 079dcf33d..8ccb0ce2d 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 block + * \ingroup demodulation * * 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 92a16e3b6..2ee2a021a 100644 --- a/gnuradio-core/src/lib/general/gr_random.h +++ b/gnuradio-core/src/lib/general/gr_random.h @@ -27,6 +27,7 @@ /*! * \brief pseudo random number generator + * \ingroup math */ 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 dd3f45a37..751bc5157 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 block + * \ingroup level * * 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_remez.h b/gnuradio-core/src/lib/general/gr_remez.h index ed4ea79b5..85e1516a5 100644 --- a/gnuradio-core/src/lib/general/gr_remez.h +++ b/gnuradio-core/src/lib/general/gr_remez.h @@ -30,6 +30,7 @@ /*! * \brief Parks-McClellan FIR filter design. * + * \ingroup filter_design * * Calculates the optimal (in the Chebyshev/minimax sense) FIR filter * inpulse reponse given a set of band edges, the desired reponse on diff --git a/gnuradio-core/src/lib/general/gr_rms_cf.h b/gnuradio-core/src/lib/general/gr_rms_cf.h index cbe6a8402..024a0ce3f 100644 --- a/gnuradio-core/src/lib/general/gr_rms_cf.h +++ b/gnuradio-core/src/lib/general/gr_rms_cf.h @@ -33,6 +33,7 @@ gr_make_rms_cf (double alpha = 0.0001); /*! * \brief RMS average power + * \ingroup math */ 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 19d3aa65f..f41f4d418 100644 --- a/gnuradio-core/src/lib/general/gr_rms_ff.h +++ b/gnuradio-core/src/lib/general/gr_rms_ff.h @@ -33,6 +33,7 @@ gr_make_rms_ff (double alpha = 0.0001); /*! * \brief RMS average power + * \ingroup math */ class gr_rms_ff : 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 db335fe04..8fb336b42 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 block + * \ingroup synch */ 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 4809ab477..29c198822 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 block + * \ingroup synch */ 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 2bda708e1..1dbaff828 100644 --- a/gnuradio-core/src/lib/general/gr_simple_framer_sync.h +++ b/gnuradio-core/src/lib/general/gr_simple_framer_sync.h @@ -23,11 +23,12 @@ #ifndef INCLUDED_GR_SIMPLE_FRAMER_SYNC_H #define INCLUDED_GR_SIMPLE_FRAMER_SYNC_H -/* - * Here are a couple of maximum length sequences (m-sequences) that were generated by the +/*! + * \brief Here are a couple of maximum length sequences (m-sequences) that were generated by the * the "mseq" matlab/octave code downloaded from: * http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=990&objectType=file * + * \ingroup synch * 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 474796404..135331634 100644 --- a/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h +++ b/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h @@ -33,6 +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 */ 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 a935af8cc..c479bab0c 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 block + * \ingroup flow * * 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 8a3f4742e..b8c06b35d 100644 --- a/gnuradio-core/src/lib/general/gr_stream_mux.h +++ b/gnuradio-core/src/lib/general/gr_stream_mux.h @@ -27,12 +27,10 @@ #include <gr_block.h> #include <vector> -class gr_stream_mux; -typedef boost::shared_ptr<gr_stream_mux> gr_stream_mux_sptr; - /*! * \brief Creates a stream muxing block to multiplex many streams into * one with a specified format. + * \ingroup converter * * \param itemsize the item size of the stream * \param length a vector (list/tuple) specifying the number of @@ -42,6 +40,10 @@ typedef boost::shared_ptr<gr_stream_mux> gr_stream_mux_sptr; * indefinitely for the items. * */ +class gr_stream_mux; +typedef boost::shared_ptr<gr_stream_mux> gr_stream_mux_sptr; + + gr_stream_mux_sptr gr_make_stream_mux (size_t itemsize, const std::vector<int> &lengths); 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 14799952f..5e0cddffe 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 block + * \ingroup converter * * 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 a413f0951..067e8742b 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 block + * \ingroup converter */ 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 3df8f7a20..e3f27d5b8 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 block + * \ingroup converter * * 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 85aba0aa4..0813638c4 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 block + * \ingroup converter */ class gr_streams_to_vector : public gr_sync_block { diff --git a/gnuradio-core/src/lib/general/gr_test.h b/gnuradio-core/src/lib/general/gr_test.h index baec1702d..978d1395c 100644 --- a/gnuradio-core/src/lib/general/gr_test.h +++ b/gnuradio-core/src/lib/general/gr_test.h @@ -39,7 +39,7 @@ gr_test_sptr gr_make_test (const std::string &name=std::string("gr_test"), /*! * \brief Test class for testing runtime system (setting up buffers and such.) - * \ingroup block + * \ingroup misc * * This block does not do any usefull actual data processing. * It just exposes setting all standard block parameters using the contructor or public methods. diff --git a/gnuradio-core/src/lib/general/gr_threshold_ff.h b/gnuradio-core/src/lib/general/gr_threshold_ff.h index 2589b188f..01f28aedc 100644 --- a/gnuradio-core/src/lib/general/gr_threshold_ff.h +++ b/gnuradio-core/src/lib/general/gr_threshold_ff.h @@ -31,8 +31,8 @@ typedef boost::shared_ptr<gr_threshold_ff> gr_threshold_ff_sptr; gr_threshold_ff_sptr gr_make_threshold_ff (float lo, float hi, float initial_state=0); /*! - * \brief - * \ingroup block + * \brief Please fix my documentation + * \ingroup misc */ 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 2f862c05f..f1c29c3cd 100644 --- a/gnuradio-core/src/lib/general/gr_throttle.h +++ b/gnuradio-core/src/lib/general/gr_throttle.h @@ -35,7 +35,7 @@ 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 block + * \ingroup flow * * input: one stream of itemsize; output: one stream of itemsize */ 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 f027db74f..a24a4b731 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 @@ -32,7 +32,8 @@ gr_unpack_k_bits_bb_sptr gr_make_unpack_k_bits_bb (unsigned k); class gr_unpack_k_bits_bb; /*! - * \brief Converts a byte with k relevent bits to k output bytes with 1 bit in the LSB + * \brief Converts a byte with k relevent bits to k output bytes with 1 bit in the LSB. + * \ingroup converter */ class gr_unpack_k_bits_bb : public gr_sync_interpolator { diff --git a/gnuradio-core/src/lib/general/gr_vco.h b/gnuradio-core/src/lib/general/gr_vco.h index ef82a6712..1e8636f7b 100644 --- a/gnuradio-core/src/lib/general/gr_vco.h +++ b/gnuradio-core/src/lib/general/gr_vco.h @@ -30,6 +30,7 @@ /*! * \brief base class template for Voltage Controlled Oscillator (VCO) + * \ingroup misc */ //FIXME Eventually generalize this to fixed point diff --git a/gnuradio-core/src/lib/general/gr_vco_f.h b/gnuradio-core/src/lib/general/gr_vco_f.h index c4182852b..8e5400443 100644 --- a/gnuradio-core/src/lib/general/gr_vco_f.h +++ b/gnuradio-core/src/lib/general/gr_vco_f.h @@ -25,21 +25,22 @@ #include <gr_sync_block.h> #include <gr_fxpt_vco.h> -class gr_vco_f; -typedef boost::shared_ptr<gr_vco_f> gr_vco_f_sptr; - /*! * \brief VCO - Voltage controlled oscillator + * \ingroup misc * * \param sampling_rate sampling rate (Hz) * \param sensitivity units are radians/sec/volt * \param amplitude output amplitude */ +class gr_vco_f; +typedef boost::shared_ptr<gr_vco_f> gr_vco_f_sptr; + + gr_vco_f_sptr gr_make_vco_f(double sampling_rate, double sensitivity, double amplitude); /*! * \brief VCO - Voltage controlled oscillator - * \ingroup block * * 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 95148691e..e29cd2e50 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 block + * \ingroup converter */ 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 3b1283949..5d1ba75f1 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 block + * \ingroup converter */ class gr_vector_to_streams : 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 30f831626..04b8f3122 100644 --- a/gnuradio-core/src/lib/general/gri_agc2_cc.h +++ b/gnuradio-core/src/lib/general/gri_agc2_cc.h @@ -27,6 +27,7 @@ /*! * \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_agc2_ff.h b/gnuradio-core/src/lib/general/gri_agc2_ff.h index a06dab78c..d83ed180a 100644 --- a/gnuradio-core/src/lib/general/gri_agc2_ff.h +++ b/gnuradio-core/src/lib/general/gri_agc2_ff.h @@ -27,6 +27,7 @@ /*! * \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 bc31d9a3d..1d8a764e8 100644 --- a/gnuradio-core/src/lib/general/gri_agc_cc.h +++ b/gnuradio-core/src/lib/general/gri_agc_cc.h @@ -27,6 +27,7 @@ /*! * \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 b9c12402a..53cf61f0e 100644 --- a/gnuradio-core/src/lib/general/gri_agc_ff.h +++ b/gnuradio-core/src/lib/general/gri_agc_ff.h @@ -27,6 +27,7 @@ /*! * \brief high performance Automatic Gain Control class + * \ingroup level * * Power is approximated by absolute value */ diff --git a/gnuradio-core/src/lib/general/gri_fft.h b/gnuradio-core/src/lib/general/gri_fft.h index 267aa7c64..7bfdce0b9 100644 --- a/gnuradio-core/src/lib/general/gri_fft.h +++ b/gnuradio-core/src/lib/general/gri_fft.h @@ -30,6 +30,7 @@ /*! * \brief FFT: complex in, complex out + * \ingroup dft */ class gri_fft_complex { @@ -61,6 +62,7 @@ public: /*! * \brief FFT: real in, complex out + * \ingroup dft */ class gri_fft_real_fwd { int d_fft_size; @@ -91,6 +93,7 @@ public: /*! * \brief FFT: complex in, float out + * \ingroup dft */ 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 07d9121ac..7b4fe7c06 100644 --- a/gnuradio-core/src/lib/general/gri_glfsr.h +++ b/gnuradio-core/src/lib/general/gri_glfsr.h @@ -25,6 +25,7 @@ /*! * \brief Galois Linear Feedback Shift Register using specified polynomial mask + * \ingroup math * * 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 c34a8fd68..5772edfb4 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,6 +25,7 @@ /*! * \brief Linear Feedback Shift Register using primitive polynomial x^15 + x + 1 + * \ingroup math * * 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 cd214d01f..3519cd278 100644 --- a/gnuradio-core/src/lib/general/gri_lfsr_32k.h +++ b/gnuradio-core/src/lib/general/gri_lfsr_32k.h @@ -27,6 +27,7 @@ /*! * \brief generate pseudo-random sequence of length 32768 bits. + * \ingroup math * * 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 6bd68fc73..6bfcef072 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 block + * \ingroup math * * 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 88dd10607..7096a4bf3 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 block + * \ingroup math */ 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 e6a8e9b50..a72975c2b 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 block + * \ingroup math */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_add_vXX.h.t b/gnuradio-core/src/lib/gengen/gr_add_vXX.h.t index e229f9682..595195bba 100755 --- a/gnuradio-core/src/lib/gengen/gr_add_vXX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_add_vXX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = sum (input_0, input_1, ...) - * \ingroup block + * \ingroup math * * Add across all input vectors. */ 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 506f09bbf..10858261c 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 block + * \ingroup converter * * 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 96e72f037..0a1d4d8ac 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 block + * \ingroup math * * Divide across all input streams. */ 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 fc48fe0b4..409825871 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 block + * \ingroup math * * 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 9db226369..6fda03c81 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 block + * \ingroup math */ 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 0f43c5de6..c6368ac81 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 block + * \ingroup math */ class @NAME@ : public gr_sync_block { diff --git a/gnuradio-core/src/lib/gengen/gr_multiply_vXX.h.t b/gnuradio-core/src/lib/gengen/gr_multiply_vXX.h.t index 560ec7cc0..41feeddcc 100755 --- a/gnuradio-core/src/lib/gengen/gr_multiply_vXX.h.t +++ b/gnuradio-core/src/lib/gengen/gr_multiply_vXX.h.t @@ -34,7 +34,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief output = prod (input_0, input_1, ...) - * \ingroup block + * \ingroup math * * Element-wise multiply across all input vectors. */ 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 74a922a2b..6501e256f 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 block + * \ingroup level */ class @NAME@ : public gr_sync_block { 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 5b52ba87e..253bd2863 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 block + * \ingroup converter * * 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 fdd0625df..78a3e25b5 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 block + * \ingroup level * * 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 2c78265b3..e804775bd 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 block + * \ingroup level * * 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_sub_XX.h.t b/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t index f96906afb..8839a158a 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 block + * \ingroup math * * 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 24c5db42a..2bac0ebc4 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 block + * \ingroup converter * * input: stream of @I_TYPE@; output: stream of @O_TYPE@ * diff --git a/gnuradio-core/src/lib/io/i2c_bbio.h b/gnuradio-core/src/lib/io/i2c_bbio.h index 2777e747f..c6b226e39 100644 --- a/gnuradio-core/src/lib/io/i2c_bbio.h +++ b/gnuradio-core/src/lib/io/i2c_bbio.h @@ -31,6 +31,7 @@ typedef boost::shared_ptr<i2c_bbio> i2c_bbio_sptr; /*! * \brief abstract class that implements bit banging i/o for i2c bus. + * \ingroup base */ class i2c_bbio { public: diff --git a/gnuradio-core/src/lib/io/i2c_bbio_pp.h b/gnuradio-core/src/lib/io/i2c_bbio_pp.h index 000b5b91e..5a99cdcd1 100644 --- a/gnuradio-core/src/lib/io/i2c_bbio_pp.h +++ b/gnuradio-core/src/lib/io/i2c_bbio_pp.h @@ -29,6 +29,7 @@ /*! * \brief concrete class that bit bangs eval board i2c bus using parallel port * + * \ingroup base * This class talks to the i2c bus on the microtune eval board using * the parallel port. This works for both the 4937 and 4702 boards. */ diff --git a/gnuradio-core/src/lib/io/i2c_bitbang.h b/gnuradio-core/src/lib/io/i2c_bitbang.h index 97c497fbe..c9deb38ba 100644 --- a/gnuradio-core/src/lib/io/i2c_bitbang.h +++ b/gnuradio-core/src/lib/io/i2c_bitbang.h @@ -28,6 +28,7 @@ /*! * \brief class for controlling i2c bus + * \ingroup base */ class i2c_bitbang : public i2c { friend i2c_sptr make_i2c_bitbang (i2c_bbio_sptr io); diff --git a/gnuradio-core/src/lib/io/microtune_4702.h b/gnuradio-core/src/lib/io/microtune_4702.h index 1f41ee0a1..95c64abe7 100644 --- a/gnuradio-core/src/lib/io/microtune_4702.h +++ b/gnuradio-core/src/lib/io/microtune_4702.h @@ -27,6 +27,7 @@ /*! * \brief class for controlling microtune 4702 tuner module + * \ingroup hardware */ class microtune_4702 : public microtune_xxxx { diff --git a/gnuradio-core/src/lib/io/microtune_4702_eval_board.h b/gnuradio-core/src/lib/io/microtune_4702_eval_board.h index e0e2f9c65..6e9726917 100644 --- a/gnuradio-core/src/lib/io/microtune_4702_eval_board.h +++ b/gnuradio-core/src/lib/io/microtune_4702_eval_board.h @@ -27,6 +27,7 @@ /*! * \brief control microtune 4702 eval board + * \ingroup hardware */ class microtune_4702_eval_board : public microtune_xxxx_eval_board { diff --git a/gnuradio-core/src/lib/io/microtune_4937.h b/gnuradio-core/src/lib/io/microtune_4937.h index 2d0f2be6c..b263ceb0f 100644 --- a/gnuradio-core/src/lib/io/microtune_4937.h +++ b/gnuradio-core/src/lib/io/microtune_4937.h @@ -27,6 +27,7 @@ /*! * \brief class for controlling microtune 4937 tuner module + * \ingroup hardware */ class microtune_4937 : public microtune_xxxx { public: diff --git a/gnuradio-core/src/lib/io/microtune_4937_eval_board.h b/gnuradio-core/src/lib/io/microtune_4937_eval_board.h index c6ab5b84e..154a7281a 100644 --- a/gnuradio-core/src/lib/io/microtune_4937_eval_board.h +++ b/gnuradio-core/src/lib/io/microtune_4937_eval_board.h @@ -27,6 +27,7 @@ /*! * \brief control microtune 4937 eval board + * \ingroup hardware */ class microtune_4937_eval_board : public microtune_xxxx_eval_board { diff --git a/gnuradio-core/src/lib/io/microtune_xxxx.h b/gnuradio-core/src/lib/io/microtune_xxxx.h index 554503561..4d5074a85 100644 --- a/gnuradio-core/src/lib/io/microtune_xxxx.h +++ b/gnuradio-core/src/lib/io/microtune_xxxx.h @@ -30,6 +30,7 @@ typedef boost::shared_ptr<i2c> i2c_sptr; /*! * \brief abstract class for controlling microtune {4937,4702} tuner modules + * \ingroup base */ class microtune_xxxx { public: diff --git a/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h b/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h index 18e50d60c..808075e55 100644 --- a/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h +++ b/gnuradio-core/src/lib/io/microtune_xxxx_eval_board.h @@ -35,6 +35,7 @@ typedef boost::shared_ptr<i2c> i2c_sptr; /*! * \brief abstract class for controlling microtune xxxx eval board + * \ingroup hardware */ class microtune_xxxx_eval_board { public: diff --git a/gnuradio-core/src/lib/io/ppio.h b/gnuradio-core/src/lib/io/ppio.h index da5ba70ce..e1a62e2a3 100644 --- a/gnuradio-core/src/lib/io/ppio.h +++ b/gnuradio-core/src/lib/io/ppio.h @@ -31,6 +31,7 @@ typedef boost::shared_ptr<ppio> ppio_sptr; /*! * \brief abstract class that provides low level access to parallel port bits + * \ingroup hardware */ class ppio { diff --git a/gnuradio-core/src/lib/io/ppio_ppdev.h b/gnuradio-core/src/lib/io/ppio_ppdev.h index d5acfefc0..b5abe3f0a 100644 --- a/gnuradio-core/src/lib/io/ppio_ppdev.h +++ b/gnuradio-core/src/lib/io/ppio_ppdev.h @@ -30,6 +30,7 @@ typedef boost::shared_ptr<ppio_ppdev> ppio_ppdev_sptr; /*! * \brief access to parallel port bits using the linux ppdev interface + * \ingroup hardware */ class ppio_ppdev : public ppio { diff --git a/gnuradio-core/src/lib/io/sdr_1000.h b/gnuradio-core/src/lib/io/sdr_1000.h index 2867c1ba9..113e85deb 100644 --- a/gnuradio-core/src/lib/io/sdr_1000.h +++ b/gnuradio-core/src/lib/io/sdr_1000.h @@ -34,6 +34,7 @@ enum { L_EXT = 0, L_BAND = 1, L_DDS0 = 2, L_DDS1 = 3 }; /*! * \brief Very low level interface to SDR 1000 xcvr hardware * \sa sdr_1000.py for a higher level interface. + * \ingroup hardware */ class sdr_1000_base { ppio_sptr d_ppio; diff --git a/gnuradio-core/src/lib/runtime/gr_basic_block.h b/gnuradio-core/src/lib/runtime/gr_basic_block.h index b2b8b42a3..8dc965da7 100644 --- a/gnuradio-core/src/lib/runtime/gr_basic_block.h +++ b/gnuradio-core/src/lib/runtime/gr_basic_block.h @@ -29,7 +29,7 @@ /*! * \brief The abstract base class for all signal processing blocks. - * \ingroup block + * \ingroup base * * 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 ce58ca9ac..79237ee83 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 block + * \ingroup base * * 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_dispatcher.h b/gnuradio-core/src/lib/runtime/gr_dispatcher.h index acfc428a2..34f825102 100644 --- a/gnuradio-core/src/lib/runtime/gr_dispatcher.h +++ b/gnuradio-core/src/lib/runtime/gr_dispatcher.h @@ -34,6 +34,7 @@ gr_dispatcher_sptr gr_make_dispatcher(); /*! * \brief invoke callbacks based on select. + * \ingroup internal * * \sa gr_select_handler */ diff --git a/gnuradio-core/src/lib/runtime/gr_error_handler.h b/gnuradio-core/src/lib/runtime/gr_error_handler.h index eb69fccb5..530a2c23c 100644 --- a/gnuradio-core/src/lib/runtime/gr_error_handler.h +++ b/gnuradio-core/src/lib/runtime/gr_error_handler.h @@ -48,6 +48,7 @@ /*! * \brief abstract error handler + * \ingroup base */ class gr_error_handler { public: diff --git a/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h b/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h index 0f4928064..10c5d6416 100644 --- a/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h +++ b/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h @@ -36,6 +36,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 * */ 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 131e41bb9..c97a50782 100644 --- a/gnuradio-core/src/lib/runtime/gr_flowgraph.h +++ b/gnuradio-core/src/lib/runtime/gr_flowgraph.h @@ -28,6 +28,7 @@ /*! *\brief Class representing a specific input or output graph endpoint + * \ingroup internal * */ class gr_endpoint diff --git a/gnuradio-core/src/lib/runtime/gr_hier_block2.h b/gnuradio-core/src/lib/runtime/gr_hier_block2.h index 6124e4d51..d04acb970 100644 --- a/gnuradio-core/src/lib/runtime/gr_hier_block2.h +++ b/gnuradio-core/src/lib/runtime/gr_hier_block2.h @@ -26,6 +26,7 @@ /*! * \brief public constructor for gr_hier_block2 + */ gr_hier_block2_sptr gr_make_hier_block2(const std::string &name, gr_io_signature_sptr input_signature, @@ -35,6 +36,7 @@ class gr_hier_block2_detail; /*! * \brief gr_hier_block2 - Hierarchical container class for gr_block's + * \ingroup internal * */ class gr_hier_block2 : public gr_basic_block diff --git a/gnuradio-core/src/lib/runtime/gr_io_signature.h b/gnuradio-core/src/lib/runtime/gr_io_signature.h index aa839ad0c..bf71dea57 100644 --- a/gnuradio-core/src/lib/runtime/gr_io_signature.h +++ b/gnuradio-core/src/lib/runtime/gr_io_signature.h @@ -28,6 +28,7 @@ /*! * \brief Create an i/o signature * + * \ingroup internal * \param min_streams specify minimum number of streams (>= 0) * \param max_streams specify maximum number of streams (>= min_streams or -1 -> infinite) * \param sizeof_stream_item specify the size of the items in each stream diff --git a/gnuradio-core/src/lib/runtime/gr_local_sighandler.h b/gnuradio-core/src/lib/runtime/gr_local_sighandler.h index c753f0ff5..6b60cf09a 100644 --- a/gnuradio-core/src/lib/runtime/gr_local_sighandler.h +++ b/gnuradio-core/src/lib/runtime/gr_local_sighandler.h @@ -32,6 +32,7 @@ /*! * \brief Get and set signal handler. * + * \ingroup internal * Constructor installs new handler, destructor reinstalls * original value. */ diff --git a/gnuradio-core/src/lib/runtime/gr_message.h b/gnuradio-core/src/lib/runtime/gr_message.h index e3c52a581..179f7d9bc 100644 --- a/gnuradio-core/src/lib/runtime/gr_message.h +++ b/gnuradio-core/src/lib/runtime/gr_message.h @@ -38,8 +38,9 @@ gr_message_sptr gr_make_message_from_string(const std::string s, long type = 0, double arg1 = 0, double arg2 = 0); /*! - * \brief Message. + * \brief Message class. * + * \ingroup misc * The ideas and method names for adjustable message length were * lifted from the click modular router "Packet" class. */ diff --git a/gnuradio-core/src/lib/runtime/gr_msg_handler.h b/gnuradio-core/src/lib/runtime/gr_msg_handler.h index 443611841..774dce73e 100644 --- a/gnuradio-core/src/lib/runtime/gr_msg_handler.h +++ b/gnuradio-core/src/lib/runtime/gr_msg_handler.h @@ -29,6 +29,7 @@ typedef boost::shared_ptr<gr_msg_handler> gr_msg_handler_sptr; /*! * \brief abstract class of message handlers + * \ingroup base */ class gr_msg_handler { public: diff --git a/gnuradio-core/src/lib/runtime/gr_msg_queue.h b/gnuradio-core/src/lib/runtime/gr_msg_queue.h index fc4c2407f..38556b3ca 100644 --- a/gnuradio-core/src/lib/runtime/gr_msg_queue.h +++ b/gnuradio-core/src/lib/runtime/gr_msg_queue.h @@ -32,6 +32,7 @@ gr_msg_queue_sptr gr_make_msg_queue(unsigned int limit=0); /*! * \brief thread-safe message queue + * \ingroup misc */ class gr_msg_queue : public gr_msg_handler { omni_mutex d_mutex; diff --git a/gnuradio-core/src/lib/runtime/gr_realtime.h b/gnuradio-core/src/lib/runtime/gr_realtime.h index 49a52a0d5..cf0423aaa 100644 --- a/gnuradio-core/src/lib/runtime/gr_realtime.h +++ b/gnuradio-core/src/lib/runtime/gr_realtime.h @@ -32,6 +32,7 @@ typedef enum { /*! * \brief If possible, enable high-priority "real time" scheduling. + * \ingroup misc */ gr_rt_status_t gr_enable_realtime_scheduling(); diff --git a/gnuradio-core/src/lib/runtime/gr_scheduler_thread.h b/gnuradio-core/src/lib/runtime/gr_scheduler_thread.h index c989f797c..89daba403 100644 --- a/gnuradio-core/src/lib/runtime/gr_scheduler_thread.h +++ b/gnuradio-core/src/lib/runtime/gr_scheduler_thread.h @@ -35,6 +35,7 @@ typedef gr_scheduler_thread_vector_t::iterator gr_scheduler_thread_viter_t; /*! *\brief A single thread of execution for the scheduler * + * \ingroup internal * This class implements a single thread that runs undetached, and * invokes the single-threaded block scheduler. The runtime makes * one of these for each distinct partition of a flowgraph and runs diff --git a/gnuradio-core/src/lib/runtime/gr_select_handler.h b/gnuradio-core/src/lib/runtime/gr_select_handler.h index cc883dc90..c3808995b 100644 --- a/gnuradio-core/src/lib/runtime/gr_select_handler.h +++ b/gnuradio-core/src/lib/runtime/gr_select_handler.h @@ -31,6 +31,7 @@ typedef boost::shared_ptr<gr_select_handler> gr_select_handler_sptr; /*! * \brief Abstract handler for select based notification. + * \ingroup base * * \sa gr_dispatcher */ diff --git a/gnuradio-core/src/lib/runtime/gr_sync_block.h b/gnuradio-core/src/lib/runtime/gr_sync_block.h index dcc7e2e73..c7f7d4df3 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 block + * \ingroup internal * * 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 4666ece8e..1482ecc00 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 block + * \ingroup internal * * 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 46851de2d..b5dfed70c 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 block + * \ingroup internal * * Override work to provide the signal processing implementation. */ diff --git a/gnuradio-core/src/lib/runtime/gr_timer.h b/gnuradio-core/src/lib/runtime/gr_timer.h index 2e1106037..ff14e315d 100644 --- a/gnuradio-core/src/lib/runtime/gr_timer.h +++ b/gnuradio-core/src/lib/runtime/gr_timer.h @@ -33,6 +33,7 @@ typedef void (*gr_timer_hook)(gr_timer *, void *); /*! * \brief create a timeout. * + * \ingroup misc * gr_timer_hook is called when timer fires. */ gr_timer_sptr gr_make_timer (gr_timer_hook, void *); diff --git a/gnuradio-core/src/lib/runtime/gr_top_block.h b/gnuradio-core/src/lib/runtime/gr_top_block.h index 57c36ad3b..28814a9a0 100644 --- a/gnuradio-core/src/lib/runtime/gr_top_block.h +++ b/gnuradio-core/src/lib/runtime/gr_top_block.h @@ -31,6 +31,7 @@ gr_top_block_sptr gr_make_top_block(const std::string &name); /*! *\brief Top-level hierarchical block representing a flowgraph + * \ingroup internal * */ class gr_top_block : public gr_hier_block2 diff --git a/gnuradio-core/src/lib/runtime/gr_top_block_impl.h b/gnuradio-core/src/lib/runtime/gr_top_block_impl.h index 00cb7f979..1868cffd6 100644 --- a/gnuradio-core/src/lib/runtime/gr_top_block_impl.h +++ b/gnuradio-core/src/lib/runtime/gr_top_block_impl.h @@ -28,6 +28,7 @@ /*! *\brief Implementation details of gr_top_block * + * \ingroup internal * The actual implementation of gr_top_block. Separate class allows * decoupling of changes from dependent classes. * diff --git a/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h b/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h index c224b7852..0d4f45832 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h @@ -27,6 +27,7 @@ /*! * \brief abstract class to implement doubly mapped virtual memory circular buffers + * \ingroup base */ 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 c866e80e8..2bb7bb16f 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h @@ -30,6 +30,7 @@ #endif /*! * \brief concrete class to implement circular buffers with mmap and shm_open + * \ingroup base */ 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 1444a68d7..7e628fa59 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,6 +27,7 @@ /*! * \brief concrete class to implement circular buffers with mmap and shm_open + * \ingroup base */ 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 5c84dd69a..da91d2f02 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h @@ -27,6 +27,7 @@ /*! * \brief concrete class to implement circular buffers with mmap and shm_open + * \ingroup base */ 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 d5f739ae4..ffc74918e 100644 --- a/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h +++ b/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h @@ -27,6 +27,7 @@ /*! * \brief concrete class to implement circular buffers with mmap and shm_open + * \ingroup base */ class gr_vmcircbuf_sysv_shm : public gr_vmcircbuf { public: |