diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-04-03 19:33:32 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-04-04 10:38:29 -0400 |
| commit | d44322fd03661c1eb6e45e3e364e81bb5131239b (patch) | |
| tree | 17c068dc4081f9bbdeaeb046ca20ee53794b2e27 /gr-analog/include | |
| parent | 9ce3e6b3f658b9273f048e1a3580be65dc08bef1 (diff) | |
docs: updating Doxygen categories for all blocks.
Block categories in Doxygen now match where they are in GRC's category tree.
Diffstat (limited to 'gr-analog/include')
29 files changed, 46 insertions, 29 deletions
diff --git a/gr-analog/include/analog/agc.h b/gr-analog/include/analog/agc.h index 92d777fa19..c939431fe4 100644 --- a/gr-analog/include/analog/agc.h +++ b/gr-analog/include/analog/agc.h @@ -34,6 +34,7 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class for complex signals. * + * \details * For Power the absolute value of the complex number is used. */ class ANALOG_API agc_cc diff --git a/gr-analog/include/analog/agc2.h b/gr-analog/include/analog/agc2.h index 75a203e9fc..be28301070 100644 --- a/gr-analog/include/analog/agc2.h +++ b/gr-analog/include/analog/agc2.h @@ -34,6 +34,7 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class * + * \details * For Power the absolute value of the complex number is used. */ class ANALOG_API agc2_cc diff --git a/gr-analog/include/analog/agc2_cc.h b/gr-analog/include/analog/agc2_cc.h index c922ccd4da..87e6200346 100644 --- a/gr-analog/include/analog/agc2_cc.h +++ b/gr-analog/include/analog/agc2_cc.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class - * \ingroup level_blk + * \ingroup level_controllers_blk * + * \details * For Power the absolute value of the complex number is used. */ class ANALOG_API agc2_cc : virtual public gr_sync_block diff --git a/gr-analog/include/analog/agc2_ff.h b/gr-analog/include/analog/agc2_ff.h index 27dd6d92e5..b960493dca 100644 --- a/gr-analog/include/analog/agc2_ff.h +++ b/gr-analog/include/analog/agc2_ff.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class + * \ingroup level_controllers_blk * - * \ingroup level_blk + * \details * Power is approximated by absolute value */ class ANALOG_API agc2_ff : virtual public gr_sync_block diff --git a/gr-analog/include/analog/agc_cc.h b/gr-analog/include/analog/agc_cc.h index b2b1a9b430..d516af4565 100644 --- a/gr-analog/include/analog/agc_cc.h +++ b/gr-analog/include/analog/agc_cc.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class - * \ingroup level_blk + * \ingroup level_controllers_blk * + * \details * For Power the absolute value of the complex number is used. */ class ANALOG_API agc_cc : virtual public gr_sync_block diff --git a/gr-analog/include/analog/agc_ff.h b/gr-analog/include/analog/agc_ff.h index 30d1ae1fd9..3056b96476 100644 --- a/gr-analog/include/analog/agc_ff.h +++ b/gr-analog/include/analog/agc_ff.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief high performance Automatic Gain Control class - * \ingroup level_blk + * \ingroup level_controllers_blk * + * \details * Power is approximated by absolute value */ class ANALOG_API agc_ff : virtual public gr_sync_block diff --git a/gr-analog/include/analog/cpfsk_bc.h b/gr-analog/include/analog/cpfsk_bc.h index 904730e2b5..8150e0d08f 100644 --- a/gr-analog/include/analog/cpfsk_bc.h +++ b/gr-analog/include/analog/cpfsk_bc.h @@ -30,7 +30,7 @@ namespace gr { /*! * \brief Perform continuous phase 2-level frequency shift keying modulation * on an input stream of unpacked bits. - * \ingroup modulation_blk + * \ingroup modulators_blk */ class ANALOG_API cpfsk_bc : virtual public gr_sync_interpolator { diff --git a/gr-analog/include/analog/cpm.h b/gr-analog/include/analog/cpm.h index d22e02321c..205fcfe809 100644 --- a/gr-analog/include/analog/cpm.h +++ b/gr-analog/include/analog/cpm.h @@ -42,6 +42,7 @@ namespace gr { /*! \brief Return the taps for an interpolating FIR filter (gr_interp_fir_filter_fff). * + * \details * These taps represent the phase response \f$g(k)\f$ for use in a CPM modulator, * see also gr_cpmmod_bc. * diff --git a/gr-analog/include/analog/ctcss_squelch_ff.h b/gr-analog/include/analog/ctcss_squelch_ff.h index f880299173..471021d008 100644 --- a/gr-analog/include/analog/ctcss_squelch_ff.h +++ b/gr-analog/include/analog/ctcss_squelch_ff.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief gate or zero output if ctcss tone not present - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API ctcss_squelch_ff : public squelch_base_ff, virtual public gr_block diff --git a/gr-analog/include/analog/dpll_bb.h b/gr-analog/include/analog/dpll_bb.h index 78efb8fde9..f25e860b2c 100644 --- a/gr-analog/include/analog/dpll_bb.h +++ b/gr-analog/include/analog/dpll_bb.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Detect the peak of a signal - * \ingroup level_blk + * \ingroup peak_detectors_blk * + * \details * If a peak is detected, this block outputs a 1, * or it outputs 0's. */ diff --git a/gr-analog/include/analog/feedforward_agc_cc.h b/gr-analog/include/analog/feedforward_agc_cc.h index 9e259a4eba..13b4fe0486 100644 --- a/gr-analog/include/analog/feedforward_agc_cc.h +++ b/gr-analog/include/analog/feedforward_agc_cc.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Non-causal AGC which computes required gain based on max absolute value over nsamples - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API feedforward_agc_cc : virtual public gr_sync_block { diff --git a/gr-analog/include/analog/fmdet_cf.h b/gr-analog/include/analog/fmdet_cf.h index 6878775e6c..bd26e39226 100644 --- a/gr-analog/include/analog/fmdet_cf.h +++ b/gr-analog/include/analog/fmdet_cf.h @@ -32,6 +32,7 @@ namespace gr { /*! * \brief Implements an IQ slope detector * + * \details * input: stream of complex; output: stream of floats * * This implements a limiting slope detector. The limiter is in diff --git a/gr-analog/include/analog/frequency_modulator_fc.h b/gr-analog/include/analog/frequency_modulator_fc.h index 8706d513a6..86f6d20d98 100644 --- a/gr-analog/include/analog/frequency_modulator_fc.h +++ b/gr-analog/include/analog/frequency_modulator_fc.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Frequency modulator block - * \ingroup modulation_blk + * \ingroup modulators_blk * + * \details * float input; complex baseband output */ class ANALOG_API frequency_modulator_fc : virtual public gr_sync_block diff --git a/gr-analog/include/analog/lfsr.h b/gr-analog/include/analog/lfsr.h index 5cf2ec70df..bb5c4b0ea4 100644 --- a/gr-analog/include/analog/lfsr.h +++ b/gr-analog/include/analog/lfsr.h @@ -35,6 +35,7 @@ namespace gr { * polynomial mask * \ingroup misc * + * \details * Generates a maximal length pseudo-random sequence of length * 2^degree-1 * diff --git a/gr-analog/include/analog/noise_source_X.h.t b/gr-analog/include/analog/noise_source_X.h.t index 9d1be6fedf..9fa470c47d 100644 --- a/gr-analog/include/analog/noise_source_X.h.t +++ b/gr-analog/include/analog/noise_source_X.h.t @@ -35,7 +35,7 @@ namespace gr { /*! * \brief Random number source - * \ingroup source_blk + * \ingroup waveform_generators_blk * * \details * Generate random values from different distributions. @@ -47,11 +47,11 @@ namespace gr { // gr::analog::@BASE_NAME@::sptr typedef boost::shared_ptr<@BASE_NAME@> sptr; - /*! \brief Make a noise source + /*! Build a noise source * \param type the random distribution to use (see analog/noise_type.h) * \param ampl a scaling factor for the output * \param seed seed for random generators. Note that for uniform and - * Gaussian distributions, this should be a negative number. + * Gaussian distributions, this should be a negative number. */ static sptr make(noise_type_t type, float ampl, long seed); diff --git a/gr-analog/include/analog/phase_modulator_fc.h b/gr-analog/include/analog/phase_modulator_fc.h index 409de7804b..2ec7c1a3c4 100644 --- a/gr-analog/include/analog/phase_modulator_fc.h +++ b/gr-analog/include/analog/phase_modulator_fc.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Phase modulator block - * \ingroup modulation_blk + * \ingroup modulators_blk * + * \details * output = complex(cos(in*sensitivity), sin(in*sensitivity)) * * Input stream 0: floats diff --git a/gr-analog/include/analog/plateau_detector_fb.h b/gr-analog/include/analog/plateau_detector_fb.h index 33629bd18b..767aafe23a 100644 --- a/gr-analog/include/analog/plateau_detector_fb.h +++ b/gr-analog/include/analog/plateau_detector_fb.h @@ -33,6 +33,7 @@ namespace gr { /*! * \brief Detects a plateau and marks the middle. * + * \details * Detect a plateau of a-priori known height. Input is a stream of floats, * the output is a stream of bytes. Whenever a plateau is detected, the * middle of that plateau is marked with a '1' on the output stream (all @@ -48,9 +49,6 @@ namespace gr { * * An implicit hysteresis is provided by the fact that after detecting one plateau, * it waits at least max_len samples before the next plateau can be detected. - * - * \ingroup analog - * */ class ANALOG_API plateau_detector_fb : virtual public gr_sync_block { diff --git a/gr-analog/include/analog/pll_carriertracking_cc.h b/gr-analog/include/analog/pll_carriertracking_cc.h index 3596429d49..bb92673185 100644 --- a/gr-analog/include/analog/pll_carriertracking_cc.h +++ b/gr-analog/include/analog/pll_carriertracking_cc.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief Implements a PLL which locks to the input frequency and outputs the * input signal mixed with that carrier. - * \ingroup sync_blk + * \ingroup synchronizers_blk * + * \details * Input stream 0: complex * Output stream 0: complex * diff --git a/gr-analog/include/analog/pll_freqdet_cf.h b/gr-analog/include/analog/pll_freqdet_cf.h index 613e85263f..a653261c30 100644 --- a/gr-analog/include/analog/pll_freqdet_cf.h +++ b/gr-analog/include/analog/pll_freqdet_cf.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief Implements a PLL which locks to the input frequency and outputs * an estimate of that frequency. Useful for FM Demod. - * \ingroup sync_blk + * \ingroup synchronizers_blk * + * \details * Input stream 0: complex * Output stream 0: float * diff --git a/gr-analog/include/analog/pll_refout_cc.h b/gr-analog/include/analog/pll_refout_cc.h index a18d177e6e..da15762779 100644 --- a/gr-analog/include/analog/pll_refout_cc.h +++ b/gr-analog/include/analog/pll_refout_cc.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Implements a PLL which locks to the input frequency and outputs a carrier - * \ingroup sync_blk + * \ingroup synchronizers_blk * + * \details * Input stream 0: complex * Output stream 0: complex * diff --git a/gr-analog/include/analog/probe_avg_mag_sqrd_c.h b/gr-analog/include/analog/probe_avg_mag_sqrd_c.h index 9e62732a36..2fed4fff0b 100644 --- a/gr-analog/include/analog/probe_avg_mag_sqrd_c.h +++ b/gr-analog/include/analog/probe_avg_mag_sqrd_c.h @@ -30,8 +30,9 @@ namespace gr { /*! * \brief compute avg magnitude squared. - * \ingroup sink_blk + * \ingroup measurement_tools_blk * + * \details * Input stream 0: complex * * Compute a running average of the magnitude squared of the the diff --git a/gr-analog/include/analog/probe_avg_mag_sqrd_cf.h b/gr-analog/include/analog/probe_avg_mag_sqrd_cf.h index b18916ae9b..303670adee 100644 --- a/gr-analog/include/analog/probe_avg_mag_sqrd_cf.h +++ b/gr-analog/include/analog/probe_avg_mag_sqrd_cf.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief compute avg magnitude squared. - * \ingroup sink_blk + * \ingroup measurement_tools_blk * + * \details * Input stream 0: complex * Output stream 0: float * diff --git a/gr-analog/include/analog/probe_avg_mag_sqrd_f.h b/gr-analog/include/analog/probe_avg_mag_sqrd_f.h index fe9d27793f..2300f8bca1 100644 --- a/gr-analog/include/analog/probe_avg_mag_sqrd_f.h +++ b/gr-analog/include/analog/probe_avg_mag_sqrd_f.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief compute avg magnitude squared. - * \ingroup sink_blk + * \ingroup measurement_tools_blk * + * \details * input stream 0: float * * Compute a running average of the magnitude squared of the the diff --git a/gr-analog/include/analog/pwr_squelch_cc.h b/gr-analog/include/analog/pwr_squelch_cc.h index 79364a86b5..840669b6b7 100644 --- a/gr-analog/include/analog/pwr_squelch_cc.h +++ b/gr-analog/include/analog/pwr_squelch_cc.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief gate or zero output when input power below threshold - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API pwr_squelch_cc : public squelch_base_cc, virtual public gr_block diff --git a/gr-analog/include/analog/pwr_squelch_ff.h b/gr-analog/include/analog/pwr_squelch_ff.h index 6fdebec746..9aca73a175 100644 --- a/gr-analog/include/analog/pwr_squelch_ff.h +++ b/gr-analog/include/analog/pwr_squelch_ff.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief gate or zero output when input power below threshold - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API pwr_squelch_ff : public squelch_base_ff, virtual public gr_block diff --git a/gr-analog/include/analog/quadrature_demod_cf.h b/gr-analog/include/analog/quadrature_demod_cf.h index 916d8b2ece..919cf779f7 100644 --- a/gr-analog/include/analog/quadrature_demod_cf.h +++ b/gr-analog/include/analog/quadrature_demod_cf.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief quadrature demodulator: complex in, float out - * \ingroup demodulation_blk + * \ingroup modulators_blk * + * \details * This can be used to demod FM, FSK, GMSK, etc. * The input is complex baseband. */ diff --git a/gr-analog/include/analog/rail_ff.h b/gr-analog/include/analog/rail_ff.h index e51b2fc935..7771fd9e8e 100644 --- a/gr-analog/include/analog/rail_ff.h +++ b/gr-analog/include/analog/rail_ff.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief clips input values to min, max - * \ingroup misc + * \ingroup level_controllers_blk */ class ANALOG_API rail_ff : virtual public gr_sync_block { diff --git a/gr-analog/include/analog/sig_source_X.h.t b/gr-analog/include/analog/sig_source_X.h.t index 2915c2abe9..752fe4cd29 100644 --- a/gr-analog/include/analog/sig_source_X.h.t +++ b/gr-analog/include/analog/sig_source_X.h.t @@ -34,7 +34,7 @@ namespace gr { /*! * \brief signal generator with @TYPE@ output. - * \ingroup source_blk + * \ingroup waveform_generators_blk */ class ANALOG_API @BASE_NAME@ : virtual public gr_sync_block { @@ -43,7 +43,7 @@ namespace gr { typedef boost::shared_ptr<@BASE_NAME@> sptr; /*! - * \brief Make a signal source block. + * Build a signal source block. * * \param sampling_freq Sampling rate of signal. * \param waveform wavetform type. diff --git a/gr-analog/include/analog/simple_squelch_cc.h b/gr-analog/include/analog/simple_squelch_cc.h index 1e12646e4e..bf949e3d2e 100644 --- a/gr-analog/include/analog/simple_squelch_cc.h +++ b/gr-analog/include/analog/simple_squelch_cc.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief simple squelch block based on average signal power and threshold in dB. - * \ingroup level_blk + * \ingroup level_controllers_blk */ class ANALOG_API simple_squelch_cc : virtual public gr_sync_block { |