diff options
author | Tom Rondeau <trondeau@vt.edu> | 2013-04-04 11:50:26 -0400 |
---|---|---|
committer | Tom Rondeau <trondeau@vt.edu> | 2013-04-04 11:50:26 -0400 |
commit | 2930f1b4265b794599d814e9a3d68fd03bde010f (patch) | |
tree | eb1a03db6962f254abb401c4e02aab5cce15d60e /gr-blocks/include/blocks | |
parent | b7175d5dcfa22c4fd1eef7a40889293cb483ec97 (diff) | |
parent | d44322fd03661c1eb6e45e3e364e81bb5131239b (diff) |
Merge branch 'master_grc_components' into next_grc_components
Conflicts:
gnuradio-core/src/lib/filter/gr_adaptive_fir_ccc.h
gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h
gnuradio-core/src/lib/filter/gr_dc_blocker_cc.h
gnuradio-core/src/lib/filter/gr_dc_blocker_ff.h
gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h
gnuradio-core/src/lib/filter/gr_fft_filter_fff.h
gnuradio-core/src/lib/filter/gr_filter_delay_fc.h
gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h
gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t
gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h
gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h
gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t
gnuradio-core/src/lib/filter/gr_goertzel_fc.h
gnuradio-core/src/lib/filter/gr_hilbert_fc.h
gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h
gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t
gnuradio-core/src/lib/filter/gr_pfb_arb_resampler_ccf.h
gnuradio-core/src/lib/filter/gr_pfb_arb_resampler_fff.h
gnuradio-core/src/lib/filter/gr_pfb_channelizer_ccf.h
gnuradio-core/src/lib/filter/gr_pfb_clock_sync_ccf.h
gnuradio-core/src/lib/filter/gr_pfb_clock_sync_fff.h
gnuradio-core/src/lib/filter/gr_pfb_decimator_ccf.h
gnuradio-core/src/lib/filter/gr_pfb_interpolator_ccf.h
gnuradio-core/src/lib/filter/gr_pfb_synthesizer_ccf.h
gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t
gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h
gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h
gnuradio-core/src/lib/filter/gri_fft_filter_ccc_generic.h
gnuradio-core/src/lib/filter/gri_fft_filter_ccc_sse.h
gnuradio-core/src/lib/general/gr_add_ff.h
gnuradio-core/src/lib/general/gr_additive_scrambler_bb.h
gnuradio-core/src/lib/general/gr_agc2_cc.h
gnuradio-core/src/lib/general/gr_agc2_ff.h
gnuradio-core/src/lib/general/gr_agc_cc.h
gnuradio-core/src/lib/general/gr_agc_ff.h
gnuradio-core/src/lib/general/gr_align_on_samplenumbers_ss.h
gnuradio-core/src/lib/general/gr_bin_statistics_f.h
gnuradio-core/src/lib/general/gr_burst_tagger.h
gnuradio-core/src/lib/general/gr_bytes_to_syms.h
gnuradio-core/src/lib/general/gr_char_to_float.h
gnuradio-core/src/lib/general/gr_char_to_short.h
gnuradio-core/src/lib/general/gr_check_counting_s.h
gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h
gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h
gnuradio-core/src/lib/general/gr_complex_to_xxx.h
gnuradio-core/src/lib/general/gr_conjugate_cc.h
gnuradio-core/src/lib/general/gr_copy.h
gnuradio-core/src/lib/general/gr_correlate_access_code_tag_bb.h
gnuradio-core/src/lib/general/gr_cpfsk_bc.h
gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h
gnuradio-core/src/lib/general/gr_decode_ccsds_27_fb.h
gnuradio-core/src/lib/general/gr_deinterleave.h
gnuradio-core/src/lib/general/gr_delay.h
gnuradio-core/src/lib/general/gr_descrambler_bb.h
gnuradio-core/src/lib/general/gr_diff_decoder_bb.h
gnuradio-core/src/lib/general/gr_diff_encoder_bb.h
gnuradio-core/src/lib/general/gr_diff_phasor_cc.h
gnuradio-core/src/lib/general/gr_dpll_bb.h
gnuradio-core/src/lib/general/gr_encode_ccsds_27_bb.h
gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h
gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h
gnuradio-core/src/lib/general/gr_fft_vcc.h
gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h
gnuradio-core/src/lib/general/gr_fft_vfc.h
gnuradio-core/src/lib/general/gr_float_to_char.h
gnuradio-core/src/lib/general/gr_float_to_complex.h
gnuradio-core/src/lib/general/gr_float_to_int.h
gnuradio-core/src/lib/general/gr_float_to_short.h
gnuradio-core/src/lib/general/gr_float_to_uchar.h
gnuradio-core/src/lib/general/gr_framer_sink_1.h
gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h
gnuradio-core/src/lib/general/gr_glfsr_source_b.h
gnuradio-core/src/lib/general/gr_glfsr_source_f.h
gnuradio-core/src/lib/general/gr_head.h
gnuradio-core/src/lib/general/gr_int_to_float.h
gnuradio-core/src/lib/general/gr_interleave.h
gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h
gnuradio-core/src/lib/general/gr_iqcomp_cc.h
gnuradio-core/src/lib/general/gr_keep_m_in_n.h
gnuradio-core/src/lib/general/gr_keep_one_in_n.h
gnuradio-core/src/lib/general/gr_kludge_copy.h
gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h
gnuradio-core/src/lib/general/gr_map_bb.h
gnuradio-core/src/lib/general/gr_message_strobe.h
gnuradio-core/src/lib/general/gr_multiply_cc.h
gnuradio-core/src/lib/general/gr_multiply_conjugate_cc.h
gnuradio-core/src/lib/general/gr_multiply_const_cc.h
gnuradio-core/src/lib/general/gr_multiply_const_ff.h
gnuradio-core/src/lib/general/gr_multiply_ff.h
gnuradio-core/src/lib/general/gr_nlog10_ff.h
gnuradio-core/src/lib/general/gr_nop.h
gnuradio-core/src/lib/general/gr_null_sink.h
gnuradio-core/src/lib/general/gr_null_source.h
gnuradio-core/src/lib/general/gr_ofdm_frame_sink2.h
gnuradio-core/src/lib/general/gr_pack_k_bits_bb.h
gnuradio-core/src/lib/general/gr_packet_sink.h
gnuradio-core/src/lib/general/gr_peak_detector2_fb.h
gnuradio-core/src/lib/general/gr_phase_modulator_fc.h
gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
gnuradio-core/src/lib/general/gr_pll_refout_cc.h
gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h
gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h
gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h
gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h
gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h
gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h
gnuradio-core/src/lib/general/gr_rail_ff.h
gnuradio-core/src/lib/general/gr_random_pdu.h
gnuradio-core/src/lib/general/gr_regenerate_bb.h
gnuradio-core/src/lib/general/gr_repeat.h
gnuradio-core/src/lib/general/gr_rms_cf.h
gnuradio-core/src/lib/general/gr_rms_ff.h
gnuradio-core/src/lib/general/gr_scrambler_bb.h
gnuradio-core/src/lib/general/gr_short_to_char.h
gnuradio-core/src/lib/general/gr_short_to_float.h
gnuradio-core/src/lib/general/gr_simple_correlator.h
gnuradio-core/src/lib/general/gr_simple_framer.h
gnuradio-core/src/lib/general/gr_simple_squelch_cc.h
gnuradio-core/src/lib/general/gr_skiphead.h
gnuradio-core/src/lib/general/gr_stream_mux.h
gnuradio-core/src/lib/general/gr_stream_to_streams.h
gnuradio-core/src/lib/general/gr_stream_to_vector.h
gnuradio-core/src/lib/general/gr_streams_to_stream.h
gnuradio-core/src/lib/general/gr_streams_to_vector.h
gnuradio-core/src/lib/general/gr_stretch_ff.h
gnuradio-core/src/lib/general/gr_tag_debug.h
gnuradio-core/src/lib/general/gr_threshold_ff.h
gnuradio-core/src/lib/general/gr_throttle.h
gnuradio-core/src/lib/general/gr_uchar_to_float.h
gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h
gnuradio-core/src/lib/general/gr_vco_f.h
gnuradio-core/src/lib/general/gr_vector_map.h
gnuradio-core/src/lib/general/gr_vector_to_stream.h
gnuradio-core/src/lib/general/gr_vector_to_streams.h
gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
gnuradio-core/src/lib/hier/gr_channel_model.h
gr-analog/include/analog/agc2_cc.h
gr-analog/include/analog/agc2_ff.h
gr-analog/include/analog/cpm.h
gr-analog/include/analog/ctcss_squelch_ff.h
gr-analog/include/analog/feedforward_agc_cc.h
gr-analog/include/analog/lfsr.h
gr-analog/include/analog/plateau_detector_fb.h
gr-blocks/grc/blocks_block_tree.xml
gr-digital/grc/digital_block_tree.xml
gr-digital/include/digital_additive_scrambler_bb.h
gr-digital/include/digital_binary_slicer_fb.h
gr-digital/include/digital_bytes_to_syms.h
gr-digital/include/digital_chunks_to_symbols_XX.h.t
gr-digital/include/digital_clock_recovery_mm_cc.h
gr-digital/include/digital_clock_recovery_mm_ff.h
gr-digital/include/digital_cma_equalizer_cc.h
gr-digital/include/digital_constellation_decoder_cb.h
gr-digital/include/digital_constellation_receiver_cb.h
gr-digital/include/digital_correlate_access_code_bb.h
gr-digital/include/digital_costas_loop_cc.h
gr-digital/include/digital_cpmmod_bc.h
gr-digital/include/digital_crc32_bb.h
gr-digital/include/digital_descrambler_bb.h
gr-digital/include/digital_diff_decoder_bb.h
gr-digital/include/digital_diff_encoder_bb.h
gr-digital/include/digital_diff_phasor_cc.h
gr-digital/include/digital_fll_band_edge_cc.h
gr-digital/include/digital_framer_sink_1.h
gr-digital/include/digital_glfsr_source_b.h
gr-digital/include/digital_glfsr_source_f.h
gr-digital/include/digital_gmskmod_bc.h
gr-digital/include/digital_kurtotic_equalizer_cc.h
gr-digital/include/digital_lms_dd_equalizer_cc.h
gr-digital/include/digital_map_bb.h
gr-digital/include/digital_mpsk_receiver_cc.h
gr-digital/include/digital_mpsk_snr_est_cc.h
gr-digital/include/digital_ofdm_chanest_vcvc.h
gr-digital/include/digital_ofdm_equalizer_base.h
gr-digital/include/digital_ofdm_equalizer_simpledfe.h
gr-digital/include/digital_ofdm_equalizer_static.h
gr-digital/include/digital_ofdm_frame_acquisition.h
gr-digital/include/digital_ofdm_frame_sink.h
gr-digital/include/digital_ofdm_insert_preamble.h
gr-digital/include/digital_ofdm_mapper_bcv.h
gr-digital/include/digital_ofdm_sync_sc_cfb.h
gr-digital/include/digital_packet_sink.h
gr-digital/include/digital_pfb_clock_sync_ccf.h
gr-digital/include/digital_pfb_clock_sync_fff.h
gr-digital/include/digital_pn_correlator_cc.h
gr-digital/include/digital_probe_density_b.h
gr-digital/include/digital_probe_mpsk_snr_est_c.h
gr-digital/include/digital_scrambler_bb.h
gr-digital/include/digital_simple_correlator.h
gr-digital/include/digital_simple_framer.h
gr-filter/grc/filter_block_tree.xml
gr-filter/include/filter/channel_model.h
gr-filter/include/filter/iir_filter_ffd.h
gr-noaa/lib/noaa_hrpt_decoder.h
gr-noaa/lib/noaa_hrpt_deframer.h
gr-noaa/lib/noaa_hrpt_pll_cf.h
gr-pager/lib/pager_flex_deinterleave.h
gr-pager/lib/pager_flex_frame.h
gr-pager/lib/pager_flex_sync.h
gr-qtgui/grc/qtgui_check_box.xml
gr-qtgui/grc/qtgui_chooser.xml
gr-qtgui/grc/qtgui_entry.xml
gr-qtgui/grc/qtgui_label.xml
gr-qtgui/grc/qtgui_range.xml
gr-qtgui/grc/qtgui_sink_x.xml
gr-qtgui/grc/qtgui_tab_widget.xml
gr-qtgui/grc/qtgui_time_sink_x.xml
gr-qtgui/include/qtgui_sink_c.h
gr-qtgui/include/qtgui_sink_f.h
gr-qtgui/include/qtgui_time_sink_c.h
gr-qtgui/include/qtgui_time_sink_f.h
gr-trellis/src/lib/fsm.h
gr-trellis/src/lib/interleaver.h
gr-trellis/src/lib/trellis_constellation_metrics_cf.h
gr-trellis/src/lib/trellis_encoder_XX.h.t
gr-trellis/src/lib/trellis_metrics_X.h.t
gr-trellis/src/lib/trellis_pccc_decoder_X.h.t
gr-trellis/src/lib/trellis_pccc_decoder_combined_XX.h.t
gr-trellis/src/lib/trellis_pccc_encoder_XX.h.t
gr-trellis/src/lib/trellis_permutation.h
gr-trellis/src/lib/trellis_sccc_decoder_X.h.t
gr-trellis/src/lib/trellis_sccc_decoder_combined_XX.h.t
gr-trellis/src/lib/trellis_sccc_encoder_XX.h.t
gr-trellis/src/lib/trellis_siso_combined_f.h
gr-trellis/src/lib/trellis_siso_f.h
gr-trellis/src/lib/trellis_viterbi_X.h.t
gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t
gr-vocoder/include/vocoder_alaw_decode_bs.h
gr-vocoder/include/vocoder_alaw_encode_sb.h
gr-vocoder/include/vocoder_codec2_decode_ps.h
gr-vocoder/include/vocoder_codec2_encode_sp.h
gr-vocoder/include/vocoder_cvsd_decode_bs.h
gr-vocoder/include/vocoder_cvsd_encode_sb.h
gr-vocoder/include/vocoder_g721_decode_bs.h
gr-vocoder/include/vocoder_g721_encode_sb.h
gr-vocoder/include/vocoder_g723_24_decode_bs.h
gr-vocoder/include/vocoder_g723_24_encode_sb.h
gr-vocoder/include/vocoder_g723_40_decode_bs.h
gr-vocoder/include/vocoder_g723_40_encode_sb.h
gr-vocoder/include/vocoder_gsm_fr_decode_ps.h
gr-vocoder/include/vocoder_gsm_fr_encode_sp.h
gr-vocoder/include/vocoder_ulaw_decode_bs.h
gr-vocoder/include/vocoder_ulaw_encode_sb.h
gr-wxgui/grc/wxgui_fftsink2.xml
gr-wxgui/grc/wxgui_waterfallsink2.xml
grc/blocks/blks2_pfb_arb_resampler.xml
grc/blocks/blks2_pfb_channelizer.xml
grc/blocks/block_tree.xml
grc/blocks/gr_add_const_vxx.xml
grc/blocks/gr_add_xx.xml
grc/blocks/gr_additive_scrambler_bb.xml
grc/blocks/gr_agc2_xx.xml
grc/blocks/gr_agc_xx.xml
grc/blocks/gr_and_const_xx.xml
grc/blocks/gr_and_xx.xml
grc/blocks/gr_argmax_xx.xml
grc/blocks/gr_burst_tagger.xml
grc/blocks/gr_channel_model.xml
grc/blocks/gr_char_to_float.xml
grc/blocks/gr_char_to_short.xml
grc/blocks/gr_chunks_to_symbols.xml
grc/blocks/gr_complex_to_arg.xml
grc/blocks/gr_complex_to_float.xml
grc/blocks/gr_complex_to_imag.xml
grc/blocks/gr_complex_to_interleaved_short.xml
grc/blocks/gr_complex_to_mag.xml
grc/blocks/gr_complex_to_mag_squared.xml
grc/blocks/gr_complex_to_real.xml
grc/blocks/gr_conjugate_cc.xml
grc/blocks/gr_copy.xml
grc/blocks/gr_cpfsk_bc.xml
grc/blocks/gr_ctcss_squelch_ff.xml
grc/blocks/gr_dc_blocker.xml
grc/blocks/gr_deinterleave.xml
grc/blocks/gr_delay.xml
grc/blocks/gr_descrambler_bb.xml
grc/blocks/gr_diff_decoder_bb.xml
grc/blocks/gr_diff_encoder_bb.xml
grc/blocks/gr_diff_phasor_cc.xml
grc/blocks/gr_divide_xx.xml
grc/blocks/gr_dpll_bb.xml
grc/blocks/gr_endian_swap.xml
grc/blocks/gr_feedforward_agc_cc.xml
grc/blocks/gr_fft_filter_xxx.xml
grc/blocks/gr_fft_vxx.xml
grc/blocks/gr_file_sink.xml
grc/blocks/gr_file_source.xml
grc/blocks/gr_filter_delay_fc.xml
grc/blocks/gr_fir_filter_xxx.xml
grc/blocks/gr_float_to_char.xml
grc/blocks/gr_float_to_complex.xml
grc/blocks/gr_float_to_int.xml
grc/blocks/gr_float_to_short.xml
grc/blocks/gr_float_to_uchar.xml
grc/blocks/gr_fractional_interpolator_xx.xml
grc/blocks/gr_freq_xlating_fir_filter_xxx.xml
grc/blocks/gr_frequency_modulator_fc.xml
grc/blocks/gr_glfsr_source_x.xml
grc/blocks/gr_goertzel_fc.xml
grc/blocks/gr_head.xml
grc/blocks/gr_hilbert_fc.xml
grc/blocks/gr_iir_filter_ffd.xml
grc/blocks/gr_int_to_float.xml
grc/blocks/gr_integrate_xx.xml
grc/blocks/gr_interleave.xml
grc/blocks/gr_interleaved_short_to_complex.xml
grc/blocks/gr_interp_fir_filter_xxx.xml
grc/blocks/gr_keep_m_in_n.xml
grc/blocks/gr_keep_one_in_n.xml
grc/blocks/gr_kludge_copy.xml
grc/blocks/gr_map_bb.xml
grc/blocks/gr_max_xx.xml
grc/blocks/gr_message_burst_source.xml
grc/blocks/gr_message_debug.xml
grc/blocks/gr_message_sink.xml
grc/blocks/gr_message_source.xml
grc/blocks/gr_message_strobe.xml
grc/blocks/gr_moving_average_xx.xml
grc/blocks/gr_multiply_const_vxx.xml
grc/blocks/gr_multiply_xx.xml
grc/blocks/gr_mute_xx.xml
grc/blocks/gr_nlog10_ff.xml
grc/blocks/gr_noise_source_x.xml
grc/blocks/gr_nop.xml
grc/blocks/gr_not_xx.xml
grc/blocks/gr_null_sink.xml
grc/blocks/gr_null_source.xml
grc/blocks/gr_or_xx.xml
grc/blocks/gr_pack_k_bits_bb.xml
grc/blocks/gr_packed_to_unpacked_xx.xml
grc/blocks/gr_pdu_to_tagged_stream.xml
grc/blocks/gr_peak_detector2_fb.xml
grc/blocks/gr_peak_detector_xb.xml
grc/blocks/gr_pfb_clock_sync.xml
grc/blocks/gr_pfb_synthesizer.xml
grc/blocks/gr_phase_modulator_fc.xml
grc/blocks/gr_pll_carriertracking_cc.xml
grc/blocks/gr_pll_freqdet_cf.xml
grc/blocks/gr_pll_refout_cc.xml
grc/blocks/gr_pn_correlator_cc.xml
grc/blocks/gr_probe_avg_mag_sqrd_x.xml
grc/blocks/gr_probe_density_b.xml
grc/blocks/gr_probe_signal_f.xml
grc/blocks/gr_pwr_squelch_xx.xml
grc/blocks/gr_quadrature_demod_cf.xml
grc/blocks/gr_rational_resampler_base_xxx.xml
grc/blocks/gr_repeat.xml
grc/blocks/gr_rms_xx.xml
grc/blocks/gr_sample_and_hold_xx.xml
grc/blocks/gr_scrambler_bb.xml
grc/blocks/gr_short_to_char.xml
grc/blocks/gr_short_to_float.xml
grc/blocks/gr_sig_source_x.xml
grc/blocks/gr_simple_correlator.xml
grc/blocks/gr_simple_framer.xml
grc/blocks/gr_simple_squelch_cc.xml
grc/blocks/gr_single_pole_iir_filter_xx.xml
grc/blocks/gr_skiphead.xml
grc/blocks/gr_socket_pdu.xml
grc/blocks/gr_stream_mux.xml
grc/blocks/gr_stream_to_streams.xml
grc/blocks/gr_stream_to_vector.xml
grc/blocks/gr_streams_to_stream.xml
grc/blocks/gr_streams_to_vector.xml
grc/blocks/gr_sub_xx.xml
grc/blocks/gr_tag_debug.xml
grc/blocks/gr_tagged_stream_to_pdu.xml
grc/blocks/gr_threshold_ff.xml
grc/blocks/gr_throttle.xml
grc/blocks/gr_transcendental.xml
grc/blocks/gr_tuntap_pdu.xml
grc/blocks/gr_uchar_to_float.xml
grc/blocks/gr_udp_sink.xml
grc/blocks/gr_udp_source.xml
grc/blocks/gr_unpack_k_bits_bb.xml
grc/blocks/gr_unpacked_to_packed_xx.xml
grc/blocks/gr_vco_f.xml
grc/blocks/gr_vector_insert_x.xml
grc/blocks/gr_vector_sink_x.xml
grc/blocks/gr_vector_source_x.xml
grc/blocks/gr_vector_to_stream.xml
grc/blocks/gr_vector_to_streams.xml
grc/blocks/gr_wavfile_sink.xml
grc/blocks/gr_wavfile_source.xml
grc/blocks/gr_xor_xx.xml
Diffstat (limited to 'gr-blocks/include/blocks')
118 files changed, 406 insertions, 186 deletions
diff --git a/gr-blocks/include/blocks/add_XX.h.t b/gr-blocks/include/blocks/add_XX.h.t index 607b820669..ffe08f683b 100644 --- a/gr-blocks/include/blocks/add_XX.h.t +++ b/gr-blocks/include/blocks/add_XX.h.t @@ -33,8 +33,9 @@ namespace gr { /*! * \brief output = sum (input_0, input_1, ...) - * \ingroup math_blk + * \ingroup math_operators_blk * + * \details * Add across all input streams. */ class BLOCKS_API @NAME@ : virtual public gr_sync_block diff --git a/gr-blocks/include/blocks/add_const_XX.h.t b/gr-blocks/include/blocks/add_const_XX.h.t index df968feac1..3a99978b6b 100644 --- a/gr-blocks/include/blocks/add_const_XX.h.t +++ b/gr-blocks/include/blocks/add_const_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input + constant - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/add_const_vXX.h.t b/gr-blocks/include/blocks/add_const_vXX.h.t index c4cd49fa48..33a50a42ca 100644 --- a/gr-blocks/include/blocks/add_const_vXX.h.t +++ b/gr-blocks/include/blocks/add_const_vXX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input + constant vector - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/add_ff.h b/gr-blocks/include/blocks/add_ff.h index 1e7350c1bb..6a9bbfbded 100644 --- a/gr-blocks/include/blocks/add_ff.h +++ b/gr-blocks/include/blocks/add_ff.h @@ -29,6 +29,13 @@ namespace gr { namespace blocks { + /*! + * \brief output = sum (input_0, input_1, ...) + * \ingroup math_operators_blk + * + * \details + * Add across all input streams. + */ class BLOCKS_API add_ff : virtual public gr_sync_block { public: diff --git a/gr-blocks/include/blocks/and_XX.h.t b/gr-blocks/include/blocks/and_XX.h.t index 68ddcc33d5..048e1bea57 100644 --- a/gr-blocks/include/blocks/and_XX.h.t +++ b/gr-blocks/include/blocks/and_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input_0 & input_1 & , ... & input_N) - * \ingroup math_blk + * \ingroup boolean_operators_blk * * bitwise boolean and across all input streams. */ diff --git a/gr-blocks/include/blocks/and_const_XX.h.t b/gr-blocks/include/blocks/and_const_XX.h.t index 945a1f48b7..9e478819cb 100644 --- a/gr-blocks/include/blocks/and_const_XX.h.t +++ b/gr-blocks/include/blocks/and_const_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output_N = input_N & value - * \ingroup math_blk + * \ingroup boolean_operators_blk * * bitwise boolean and of const to the data stream. */ diff --git a/gr-blocks/include/blocks/annotator_1to1.h b/gr-blocks/include/blocks/annotator_1to1.h index 6cc8db6eef..1c5ab038fc 100644 --- a/gr-blocks/include/blocks/annotator_1to1.h +++ b/gr-blocks/include/blocks/annotator_1to1.h @@ -32,6 +32,7 @@ namespace gr { /*! * \brief 1-to-1 stream annotator testing block. FOR TESTING PURPOSES ONLY. * + * \details * This block creates tags to be sent downstream every 10,000 * items it sees. The tags contain the name and ID of the * instantiated block, use "seq" as a key, and have a counter that diff --git a/gr-blocks/include/blocks/annotator_alltoall.h b/gr-blocks/include/blocks/annotator_alltoall.h index 558aea69ca..7bad73b291 100644 --- a/gr-blocks/include/blocks/annotator_alltoall.h +++ b/gr-blocks/include/blocks/annotator_alltoall.h @@ -32,6 +32,7 @@ namespace gr { /*! * \brief All-to-all stream annotator testing block. FOR TESTING PURPOSES ONLY. * + * \details * This block creates tags to be sent downstream every 10,000 * items it sees. The tags contain the name and ID of the * instantiated block, use "seq" as a key, and have a counter that diff --git a/gr-blocks/include/blocks/annotator_raw.h b/gr-blocks/include/blocks/annotator_raw.h index ae273c2a46..703c42516a 100644 --- a/gr-blocks/include/blocks/annotator_raw.h +++ b/gr-blocks/include/blocks/annotator_raw.h @@ -33,6 +33,7 @@ namespace gr { /*! * \brief raw stream annotator testing block. * + * \details * This block creates arbitrary tags to be sent downstream blocks * to be sent are set manually via accessor methods and are sent * only once. diff --git a/gr-blocks/include/blocks/argmax_XX.h.t b/gr-blocks/include/blocks/argmax_XX.h.t index 4c25c1c8c4..93aa367260 100644 --- a/gr-blocks/include/blocks/argmax_XX.h.t +++ b/gr-blocks/include/blocks/argmax_XX.h.t @@ -35,8 +35,9 @@ namespace gr { * \brief Compares vectors from multiple streams and determines * the index in the vector and stream number where the maximum * value occurred. - * \ingroup math_blk + * \ingroup math_operators_blk * + * \details * Data is passed in as a vector of length \p vlen from multiple * input sources. It will look through these streams of \p vlen * data items and output two streams. diff --git a/gr-blocks/include/blocks/burst_tagger.h b/gr-blocks/include/blocks/burst_tagger.h index 408405f97b..312fb2ffbd 100644 --- a/gr-blocks/include/blocks/burst_tagger.h +++ b/gr-blocks/include/blocks/burst_tagger.h @@ -31,8 +31,10 @@ namespace gr { /*! * \brief Sets a burst on/off tag based on the value of the trigger input. - * \ingroup misc_blk + * \ingroup peak_detectors_blk + * \ingroup stream_tag_tools_blk * + * \details * This block takes two inputs, a signal stream on the input * stream 0 and a trigger stream of shorts on input stream 1. If * the trigger stream goes above 0, a tag with the key "burst" diff --git a/gr-blocks/include/blocks/char_to_float.h b/gr-blocks/include/blocks/char_to_float.h index 92a2dbf800..0002ceb30b 100644 --- a/gr-blocks/include/blocks/char_to_float.h +++ b/gr-blocks/include/blocks/char_to_float.h @@ -31,10 +31,7 @@ namespace gr { /*! * \brief Convert stream of chars to a stream of float - * \ingroup converter_blk - * - * \param vlen vector length of data streams. - * \param scale a scalar divider to change the output signal scale. + * \ingroup type_converters_blk */ class BLOCKS_API char_to_float : virtual public gr_sync_block { @@ -43,6 +40,12 @@ namespace gr { // gr::blocks::char_to_float_ff::sptr typedef boost::shared_ptr<char_to_float> sptr; + /*! + * Build a chars to float stream converter block. + * + * \param vlen vector length of data streams. + * \param scale a scalar divider to change the output signal scale. + */ static sptr make(size_t vlen=1, float scale=1.0); /*! diff --git a/gr-blocks/include/blocks/char_to_short.h b/gr-blocks/include/blocks/char_to_short.h index e2bb3a8590..fc9d3b4b52 100644 --- a/gr-blocks/include/blocks/char_to_short.h +++ b/gr-blocks/include/blocks/char_to_short.h @@ -31,9 +31,7 @@ namespace gr { /*! * \brief Convert stream of chars to a stream of short - * \ingroup converter_blk - * - * \param vlen vector length of data streams. + * \ingroup type_converters_blk */ class BLOCKS_API char_to_short : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/check_lfsr_32k_s.h b/gr-blocks/include/blocks/check_lfsr_32k_s.h index 4eba436e80..6eddd607b6 100644 --- a/gr-blocks/include/blocks/check_lfsr_32k_s.h +++ b/gr-blocks/include/blocks/check_lfsr_32k_s.h @@ -33,6 +33,7 @@ namespace gr { * \brief sink that checks if its input stream consists of a lfsr_32k sequence. * \ingroup sink_blk * + * \details * This sink is typically used along with * gr::blocks::lfsr_32k_source_s to test the USRP using its * digital loopback mode. diff --git a/gr-blocks/include/blocks/complex_to_arg.h b/gr-blocks/include/blocks/complex_to_arg.h index 5d38161d45..178f846704 100644 --- a/gr-blocks/include/blocks/complex_to_arg.h +++ b/gr-blocks/include/blocks/complex_to_arg.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief complex in, arg out (float) - * \ingroup converter_blk - * \param vlen vector len (default 1) + * \ingroup type_converters_blk */ class BLOCKS_API complex_to_arg : virtual public gr_sync_block { public: - // gr::blocks::complex_to_arg_ff::sptr typedef boost::shared_ptr<complex_to_arg> sptr; + /*! + * Build a complex to arg block. + * + * \param vlen vector len (default 1) + */ static sptr make(size_t vlen=1); }; diff --git a/gr-blocks/include/blocks/complex_to_float.h b/gr-blocks/include/blocks/complex_to_float.h index 322f67b624..7648648d6c 100644 --- a/gr-blocks/include/blocks/complex_to_float.h +++ b/gr-blocks/include/blocks/complex_to_float.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief convert a stream of gr_complex to 1 or 2 streams of float - * \ingroup converter_blk - * \param vlen vector len (default 1) + * \ingroup type_converters_blk */ class BLOCKS_API complex_to_float : virtual public gr_sync_block { public: - // gr::blocks::complex_to_float_ff::sptr typedef boost::shared_ptr<complex_to_float> sptr; + /*! + * Build a complex to float block. + * + * \param vlen vector len (default 1) + */ static sptr make(size_t vlen=1); }; diff --git a/gr-blocks/include/blocks/complex_to_imag.h b/gr-blocks/include/blocks/complex_to_imag.h index 71353a94a1..cb1d32fec6 100644 --- a/gr-blocks/include/blocks/complex_to_imag.h +++ b/gr-blocks/include/blocks/complex_to_imag.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief complex in, imag out (float) - * \ingroup converter_blk - * \param vlen vector len (default 1) + * \ingroup type_converters_blk */ class BLOCKS_API complex_to_imag : virtual public gr_sync_block { public: - // gr::blocks::complex_to_imag_ff::sptr typedef boost::shared_ptr<complex_to_imag> sptr; + /*! + * Build a complex to imaginary part block. + * + * \param vlen vector len (default 1) + */ static sptr make(size_t vlen=1); }; diff --git a/gr-blocks/include/blocks/complex_to_interleaved_short.h b/gr-blocks/include/blocks/complex_to_interleaved_short.h index f5e91123ce..c7304787a9 100644 --- a/gr-blocks/include/blocks/complex_to_interleaved_short.h +++ b/gr-blocks/include/blocks/complex_to_interleaved_short.h @@ -31,15 +31,17 @@ namespace gr { /*! * \brief Convert stream of complex to a stream of interleaved shorts - * \ingroup converter_blk + * \ingroup type_converters_blk */ class BLOCKS_API complex_to_interleaved_short : virtual public gr_sync_interpolator { public: - // gr::blocks::complex_to_interleaved_short::sptr typedef boost::shared_ptr<complex_to_interleaved_short> sptr; + /*! + * Build a complex to interleaved shorts block. + */ static sptr make(); }; diff --git a/gr-blocks/include/blocks/complex_to_mag.h b/gr-blocks/include/blocks/complex_to_mag.h index 7e03c1cac4..b1758fd3eb 100644 --- a/gr-blocks/include/blocks/complex_to_mag.h +++ b/gr-blocks/include/blocks/complex_to_mag.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief complex in, magnitude out (float) - * \ingroup converter_blk - * \param vlen vector len (default 1) + * \ingroup type_converters_blk */ class BLOCKS_API complex_to_mag : virtual public gr_sync_block { public: - // gr::blocks::complex_to_mag_ff::sptr typedef boost::shared_ptr<complex_to_mag> sptr; + /*! + * Build a complex to magnitude block. + * + * \param vlen vector len (default 1) + */ static sptr make(size_t vlen=1); }; diff --git a/gr-blocks/include/blocks/complex_to_mag_squared.h b/gr-blocks/include/blocks/complex_to_mag_squared.h index 9e122b4b1b..a7c464fbb0 100644 --- a/gr-blocks/include/blocks/complex_to_mag_squared.h +++ b/gr-blocks/include/blocks/complex_to_mag_squared.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief complex in, magnitude squared out (float) - * \ingroup converter_blk - * \param vlen vector len (default 1) + * \ingroup type_converters_blk */ class BLOCKS_API complex_to_mag_squared : virtual public gr_sync_block { public: - // gr::blocks::complex_to_mag_squared_ff::sptr typedef boost::shared_ptr<complex_to_mag_squared> sptr; + /*! + * Build a complex to magnitude squared block. + * + * \param vlen vector len (default 1) + */ static sptr make(size_t vlen=1); }; diff --git a/gr-blocks/include/blocks/complex_to_real.h b/gr-blocks/include/blocks/complex_to_real.h index a891c2e086..908ca9fc94 100644 --- a/gr-blocks/include/blocks/complex_to_real.h +++ b/gr-blocks/include/blocks/complex_to_real.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief complex in, real out (float) - * \ingroup converter_blk - * \param vlen vector len (default 1) + * \ingroup type_converters_blk */ class BLOCKS_API complex_to_real : virtual public gr_sync_block { public: - // gr::blocks::complex_to_real_ff::sptr typedef boost::shared_ptr<complex_to_real> sptr; + /*! + * Build a complex to real part block. + * + * \param vlen vector len (default 1) + */ static sptr make(size_t vlen=1); }; diff --git a/gr-blocks/include/blocks/conjugate_cc.h b/gr-blocks/include/blocks/conjugate_cc.h index 02297c56e2..92096eea31 100644 --- a/gr-blocks/include/blocks/conjugate_cc.h +++ b/gr-blocks/include/blocks/conjugate_cc.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief output = complex conjugate of input - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API conjugate_cc : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/copy.h b/gr-blocks/include/blocks/copy.h index 5ed0ea0e92..a243a54917 100644 --- a/gr-blocks/include/blocks/copy.h +++ b/gr-blocks/include/blocks/copy.h @@ -33,6 +33,7 @@ namespace gr { * \brief output[i] = input[i] * \ingroup misc_blk * + * \details * When enabled (default), this block copies its input to its * output. When disabled, this block drops its input on the floor. */ diff --git a/gr-blocks/include/blocks/deinterleave.h b/gr-blocks/include/blocks/deinterleave.h index 24074d2fcf..bb6ad59a22 100644 --- a/gr-blocks/include/blocks/deinterleave.h +++ b/gr-blocks/include/blocks/deinterleave.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief deinterleave a single input into N outputs - * \ingroup slicedice_blk - * \param itemsize stream itemsize + * \ingroup stream_operators_blk */ class BLOCKS_API deinterleave : virtual public gr_sync_decimator { public: - // gr::blocks::deinterleave::sptr typedef boost::shared_ptr<deinterleave> sptr; + /*! + * Make a deinterleave block. + * + * \param itemsize stream itemsize + */ static sptr make(size_t itemsize); }; diff --git a/gr-blocks/include/blocks/divide_XX.h.t b/gr-blocks/include/blocks/divide_XX.h.t index 9a382e4a09..821a458ec4 100644 --- a/gr-blocks/include/blocks/divide_XX.h.t +++ b/gr-blocks/include/blocks/divide_XX.h.t @@ -33,8 +33,9 @@ namespace gr { /*! * \brief output = input_0 / input_1 / input_x ...) - * \ingroup math_blk + * \ingroup math_operators_blk * + * \details * Divide across all input streams. */ class BLOCKS_API @NAME@ : virtual public gr_sync_block diff --git a/gr-blocks/include/blocks/endian_swap.h b/gr-blocks/include/blocks/endian_swap.h index 4b5a76218e..c26a1d2aa4 100644 --- a/gr-blocks/include/blocks/endian_swap.h +++ b/gr-blocks/include/blocks/endian_swap.h @@ -31,9 +31,7 @@ namespace gr { /*! * \brief Convert stream of items into thier byte swapped version - * - * \param item_size_bytes number of bytes per item, 1=no-op, - * 2=uint16_t, 4=uint32_t, 8=uint64_t + * \ingroup stream_operators_blk */ class BLOCKS_API endian_swap : virtual public gr_sync_block { @@ -41,6 +39,12 @@ namespace gr { // gr::blocks::endian_swap::sptr typedef boost::shared_ptr<endian_swap> sptr; + /*! + * Make an endian swap block. + * + * \param item_size_bytes number of bytes per item, 1=no-op, + * 2=uint16_t, 4=uint32_t, 8=uint64_t + */ static sptr make(size_t item_size_bytes=1); }; diff --git a/gr-blocks/include/blocks/file_descriptor_sink.h b/gr-blocks/include/blocks/file_descriptor_sink.h index df59e24c0a..e98f918c14 100644 --- a/gr-blocks/include/blocks/file_descriptor_sink.h +++ b/gr-blocks/include/blocks/file_descriptor_sink.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Write stream to file descriptor. - * \ingroup sink_blk + * \ingroup file_operators_blk */ class BLOCKS_API file_descriptor_sink : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/file_descriptor_source.h b/gr-blocks/include/blocks/file_descriptor_source.h index ff4f14792b..ac827800cd 100644 --- a/gr-blocks/include/blocks/file_descriptor_source.h +++ b/gr-blocks/include/blocks/file_descriptor_source.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Read stream from file descriptor. - * \ingroup source_blk + * \ingroup file_operators_blk */ class BLOCKS_API file_descriptor_source : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/file_meta_sink.h b/gr-blocks/include/blocks/file_meta_sink.h index ef64887cf9..763e0a2da0 100644 --- a/gr-blocks/include/blocks/file_meta_sink.h +++ b/gr-blocks/include/blocks/file_meta_sink.h @@ -45,8 +45,9 @@ namespace gr { /*! * \brief Write stream to file with meta-data headers. - * \ingroup sink_blk + * \ingroup file_operators_blk * + * \details * These files represent data as binary information in between * meta-data headers. The headers contain information about the * type of data and properties of the data in the next segment of diff --git a/gr-blocks/include/blocks/file_meta_source.h b/gr-blocks/include/blocks/file_meta_source.h index a992d52432..83997fc9b5 100644 --- a/gr-blocks/include/blocks/file_meta_source.h +++ b/gr-blocks/include/blocks/file_meta_source.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief Reads stream from file with meta-data headers. Headers * are parsed into tags. - * \ingroup source_blk + * \ingroup file_operators_blk * + * \details * The information in the metadata headers includes: * * rx_rate (double): sample rate of data. diff --git a/gr-blocks/include/blocks/file_sink.h b/gr-blocks/include/blocks/file_sink.h index 08c2adf1f7..c894defd78 100644 --- a/gr-blocks/include/blocks/file_sink.h +++ b/gr-blocks/include/blocks/file_sink.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Write stream to file. - * \ingroup sink_blk + * \ingroup file_operators_blk */ class BLOCKS_API file_sink : virtual public gr_sync_block, virtual public file_sink_base diff --git a/gr-blocks/include/blocks/file_source.h b/gr-blocks/include/blocks/file_source.h index 1a12aa905d..6f1bc49ea1 100644 --- a/gr-blocks/include/blocks/file_source.h +++ b/gr-blocks/include/blocks/file_source.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Read stream from file - * \ingroup source_blk + * \ingroup file_operators_blk */ class BLOCKS_API file_source : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/float_to_char.h b/gr-blocks/include/blocks/float_to_char.h index de9ea85e33..c0193da573 100644 --- a/gr-blocks/include/blocks/float_to_char.h +++ b/gr-blocks/include/blocks/float_to_char.h @@ -31,18 +31,20 @@ namespace gr { /*! * \brief Convert stream of floats to a stream of char - * \ingroup converter_blk - * - * \param vlen vector length of data streams. - * \param scale a scalar multiplier to change the output signal scale. + * \ingroup type_converters_blk */ class BLOCKS_API float_to_char : virtual public gr_sync_block { public: - // gr::blocks::float_to_char_ff::sptr typedef boost::shared_ptr<float_to_char> sptr; + /*! + * Build a float to char block. + * + * \param vlen vector length of data streams. + * \param scale a scalar multiplier to change the output signal scale. + */ static sptr make(size_t vlen=1, float scale=1.0); /*! diff --git a/gr-blocks/include/blocks/float_to_complex.h b/gr-blocks/include/blocks/float_to_complex.h index 48c5b6ead4..aba9aed8c4 100644 --- a/gr-blocks/include/blocks/float_to_complex.h +++ b/gr-blocks/include/blocks/float_to_complex.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief one or two floats in, complex out - * \ingroup converter_blk - * \param vlen vector len (default 1) + * \ingroup type_converters_blk */ class BLOCKS_API float_to_complex : virtual public gr_sync_block { public: - // gr::blocks::float_to_complex_ff::sptr typedef boost::shared_ptr<float_to_complex> sptr; + /*! + * Build a float to complex block. + * + * \param vlen vector len (default 1) + */ static sptr make(size_t vlen=1); }; diff --git a/gr-blocks/include/blocks/float_to_int.h b/gr-blocks/include/blocks/float_to_int.h index 95c62e5162..3c8e7ad5ab 100644 --- a/gr-blocks/include/blocks/float_to_int.h +++ b/gr-blocks/include/blocks/float_to_int.h @@ -30,19 +30,21 @@ namespace gr { namespace blocks { /*! - * \brief Convert stream of floats to a stream of char - * \ingroup converter_blk - * - * \param vlen vector length of data streams. - * \param scale a scalar multiplier to change the output signal scale. + * \brief Convert stream of floats to a stream of ints. + * \ingroup type_converters_blk */ class BLOCKS_API float_to_int : virtual public gr_sync_block { public: - // gr::blocks::float_to_int_ff::sptr typedef boost::shared_ptr<float_to_int> sptr; + /*! + * Build a float to int block. + * + * \param vlen vector length of data streams. + * \param scale a scalar multiplier to change the output signal scale. + */ static sptr make(size_t vlen=1, float scale=1.0); /*! diff --git a/gr-blocks/include/blocks/float_to_short.h b/gr-blocks/include/blocks/float_to_short.h index 5f1ab3f958..8f5f60e55b 100644 --- a/gr-blocks/include/blocks/float_to_short.h +++ b/gr-blocks/include/blocks/float_to_short.h @@ -31,18 +31,20 @@ namespace gr { /*! * \brief Convert stream of floats to a stream of shorts - * \ingroup converter_blk - * - * \param vlen vector length of data streams. - * \param scale a scalar multiplier to change the output signal scale. + * \ingroup type_converters_blk */ class BLOCKS_API float_to_short : virtual public gr_sync_block { public: - // gr::blocks::float_to_short_ff::sptr typedef boost::shared_ptr<float_to_short> sptr; + /*! + * Build a float to short block. + * + * \param vlen vector length of data streams. + * \param scale a scalar multiplier to change the output signal scale. + */ static sptr make(size_t vlen=1, float scale=1.0); /*! diff --git a/gr-blocks/include/blocks/float_to_uchar.h b/gr-blocks/include/blocks/float_to_uchar.h index b5d0d08f7d..9bfaaa65aa 100644 --- a/gr-blocks/include/blocks/float_to_uchar.h +++ b/gr-blocks/include/blocks/float_to_uchar.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Convert stream of floats to a stream of unsigned chars - * \ingroup converter_blk + * \ingroup type_converters_blk */ class BLOCKS_API float_to_uchar : virtual public gr_sync_block { @@ -40,6 +40,9 @@ namespace gr { // gr::blocks::float_to_uchar_ff::sptr typedef boost::shared_ptr<float_to_uchar> sptr; + /*! + * Build a float to uchar block. + */ static sptr make(); }; diff --git a/gr-blocks/include/blocks/head.h b/gr-blocks/include/blocks/head.h index cc7d3808e5..4693f988b8 100644 --- a/gr-blocks/include/blocks/head.h +++ b/gr-blocks/include/blocks/head.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief copies the first N items to the output then signals done - * \ingroup slicedice_blk + * \ingroup misc_blk * + * \details * Useful for building test cases */ class BLOCKS_API head : virtual public gr_sync_block diff --git a/gr-blocks/include/blocks/int_to_float.h b/gr-blocks/include/blocks/int_to_float.h index ebee1c3c9e..179667e4df 100644 --- a/gr-blocks/include/blocks/int_to_float.h +++ b/gr-blocks/include/blocks/int_to_float.h @@ -30,19 +30,21 @@ namespace gr { namespace blocks { /*! - * \brief Convert stream of ints to a stream of floats - * \ingroup converter_blk - * - * \param vlen vector length of data streams. - * \param scale a scalar divider to change the output signal scale. + * \brief Convert stream of ints to a stream of floats. + * \ingroup type_converters_blk */ class BLOCKS_API int_to_float : virtual public gr_sync_block { public: - // gr::blocks::int_to_float_ff::sptr typedef boost::shared_ptr<int_to_float> sptr; + /*! + * Build an int to float block. + * + * \param vlen vector length of data streams. + * \param scale a scalar divider to change the output signal scale. + */ static sptr make(size_t vlen=1, float scale=1.0); /*! diff --git a/gr-blocks/include/blocks/integrate_XX.h.t b/gr-blocks/include/blocks/integrate_XX.h.t index 8a313a0ba9..45a49def0c 100644 --- a/gr-blocks/include/blocks/integrate_XX.h.t +++ b/gr-blocks/include/blocks/integrate_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief Integrate successive samples and decimate - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_decimator { diff --git a/gr-blocks/include/blocks/interleave.h b/gr-blocks/include/blocks/interleave.h index e98d01df9b..043ad6d27b 100644 --- a/gr-blocks/include/blocks/interleave.h +++ b/gr-blocks/include/blocks/interleave.h @@ -31,16 +31,19 @@ namespace gr { /*! * \brief interleave N inputs into a single output - * \ingroup slicedice_blk - * \param itemsize stream itemsize + * \ingroup stream_operators_blk */ class BLOCKS_API interleave : virtual public gr_sync_interpolator { public: - // gr::blocks::interleave::sptr typedef boost::shared_ptr<interleave> sptr; + /*! + * Make a stream interleave block. + * + * \param itemsize stream itemsize + */ static sptr make(size_t itemsize); }; diff --git a/gr-blocks/include/blocks/interleaved_short_to_complex.h b/gr-blocks/include/blocks/interleaved_short_to_complex.h index 40e96fc46a..961ce59a66 100644 --- a/gr-blocks/include/blocks/interleaved_short_to_complex.h +++ b/gr-blocks/include/blocks/interleaved_short_to_complex.h @@ -31,15 +31,17 @@ namespace gr { /*! * \brief Convert stream of interleaved shorts to a stream of complex - * \ingroup converter_blk + * \ingroup type_converters_blk */ class BLOCKS_API interleaved_short_to_complex : virtual public gr_sync_decimator { public: - // gr::blocks::interleaved_short_to_complex::sptr typedef boost::shared_ptr<interleaved_short_to_complex> sptr; + /*! + * Build an interleaved short to complex block. + */ static sptr make(); }; diff --git a/gr-blocks/include/blocks/keep_m_in_n.h b/gr-blocks/include/blocks/keep_m_in_n.h index 806ec3de54..88d94fab85 100644 --- a/gr-blocks/include/blocks/keep_m_in_n.h +++ b/gr-blocks/include/blocks/keep_m_in_n.h @@ -30,8 +30,8 @@ namespace gr { namespace blocks { /*! - * \brief decimate a stream, keeping one item out of every n. - * \ingroup slicedice_blk + * \brief decimate a stream, keeping \p m items out of every \p n. + * \ingroup stream_operators_blk */ class BLOCKS_API keep_m_in_n : virtual public gr_block { @@ -40,6 +40,14 @@ namespace gr { // gr::blocks::keep_m_in_n::sptr typedef boost::shared_ptr<keep_m_in_n> sptr; + /*! + * Make a keep m in n block. + * + * \param itemsize stream itemsize + * \param m number of items to take in block of \p n items + * \param n block size in items + * \param offset initial item offset into the stream + */ static sptr make(size_t itemsize, int m, int n, int offset); virtual void set_m(int m) = 0; diff --git a/gr-blocks/include/blocks/keep_one_in_n.h b/gr-blocks/include/blocks/keep_one_in_n.h index c487849941..9cce1e93ed 100644 --- a/gr-blocks/include/blocks/keep_one_in_n.h +++ b/gr-blocks/include/blocks/keep_one_in_n.h @@ -30,8 +30,8 @@ namespace gr { namespace blocks { /*! - * \brief decimate a stream, keeping one item out of every n. - * \ingroup slicedice_blk + * \brief decimate a stream, keeping one item out of every \p n. + * \ingroup stream_operators_blk */ class BLOCKS_API keep_one_in_n : virtual public gr_block { @@ -40,6 +40,12 @@ namespace gr { // gr::blocks::keep_one_in_n::sptr typedef boost::shared_ptr<keep_one_in_n> sptr; + /*! + * Make a keep one in n block. + * + * \param itemsize stream itemsize + * \param n block size in items + */ static sptr make(size_t itemsize, int n); virtual void set_n(int n) = 0; diff --git a/gr-blocks/include/blocks/lfsr_15_1_0.h b/gr-blocks/include/blocks/lfsr_15_1_0.h index a79ed62eb8..b906844585 100644 --- a/gr-blocks/include/blocks/lfsr_15_1_0.h +++ b/gr-blocks/include/blocks/lfsr_15_1_0.h @@ -32,6 +32,7 @@ namespace gr { * \brief Linear Feedback Shift Register using primitive polynomial x^15 + x + 1 * \ingroup misc * + * \details * Generates a maximal length pseudo-random sequence of length * 2^15 - 1 bits. */ diff --git a/gr-blocks/include/blocks/lfsr_32k.h b/gr-blocks/include/blocks/lfsr_32k.h index 7e70f6512b..23954139d8 100644 --- a/gr-blocks/include/blocks/lfsr_32k.h +++ b/gr-blocks/include/blocks/lfsr_32k.h @@ -33,6 +33,7 @@ namespace gr { * \brief generate pseudo-random sequence of length 32768 bits. * \ingroup misc * + * \details * This is based on gri_lfsr_15_1_0 with an extra 0 added at the * end of the sequence. */ diff --git a/gr-blocks/include/blocks/lfsr_32k_source_s.h b/gr-blocks/include/blocks/lfsr_32k_source_s.h index c24cc31b29..9cc32fc2c9 100644 --- a/gr-blocks/include/blocks/lfsr_32k_source_s.h +++ b/gr-blocks/include/blocks/lfsr_32k_source_s.h @@ -34,6 +34,7 @@ namespace gr { * \brief LFSR pseudo-random source with period of 2^15 bits (2^11 shorts) * \ingroup source_blk * + * \details * This source is typically used along with gr::blocks::check_lfsr_32k_s to * test the USRP using its digital loopback mode. */ diff --git a/gr-blocks/include/blocks/max_XX.h.t b/gr-blocks/include/blocks/max_XX.h.t index 9e74bf3cac..738d7bb938 100644 --- a/gr-blocks/include/blocks/max_XX.h.t +++ b/gr-blocks/include/blocks/max_XX.h.t @@ -34,8 +34,9 @@ namespace gr { /*! * \brief Compares vectors from multiple streams and determines * the maximum value from each vector over all streams. - * \ingroup math_blk + * \ingroup math_operators_blk * + * \details * Data is passed in as a vector of length \p vlen from multiple * input sources. It will look through these streams of \p vlen * data items and output two streams. diff --git a/gr-blocks/include/blocks/message_burst_source.h b/gr-blocks/include/blocks/message_burst_source.h index 864d43452f..72997abf2c 100644 --- a/gr-blocks/include/blocks/message_burst_source.h +++ b/gr-blocks/include/blocks/message_burst_source.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Turn received messages into a stream and tag them for UHD to send. - * \ingroup source_blk + * \ingroup message_tools_blk */ class BLOCKS_API message_burst_source : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/message_debug.h b/gr-blocks/include/blocks/message_debug.h index f0212331c2..59a778ba49 100644 --- a/gr-blocks/include/blocks/message_debug.h +++ b/gr-blocks/include/blocks/message_debug.h @@ -31,8 +31,11 @@ namespace gr { /*! * \brief Debug block for the message passing system. - * \ingroup sink_blk + * \ingroup message_tools_blk + * \ingroup measurement_tools_blk + * \ingroup debug_tools_blk * + * \details * The message debug block is used to capture and print or store * messages as they are received. Any block that generates a * message may connect that message port to one or more of the diff --git a/gr-blocks/include/blocks/message_sink.h b/gr-blocks/include/blocks/message_sink.h index 5d3084d02d..aec636e3cf 100644 --- a/gr-blocks/include/blocks/message_sink.h +++ b/gr-blocks/include/blocks/message_sink.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Gather received items into messages and insert into msgq - * \ingroup sink_blk + * \ingroup message_tools_blk */ class BLOCKS_API message_sink : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/message_source.h b/gr-blocks/include/blocks/message_source.h index cf4bafc22b..2aa3ddaa35 100644 --- a/gr-blocks/include/blocks/message_source.h +++ b/gr-blocks/include/blocks/message_source.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Turn received messages into a stream - * \ingroup source_blk + * \ingroup message_tools_blk */ class BLOCKS_API message_source : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/message_strobe.h b/gr-blocks/include/blocks/message_strobe.h index 6b427d539c..abd9b73596 100644 --- a/gr-blocks/include/blocks/message_strobe.h +++ b/gr-blocks/include/blocks/message_strobe.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Send message at defined interval - * \ingroup msg_blk + * \ingroup message_tools_blk * + * \details * Takes a PMT message and sends it out every \p period_ms * milliseconds. Useful for testing/debugging the message system. */ diff --git a/gr-blocks/include/blocks/moving_average_XX.h.t b/gr-blocks/include/blocks/moving_average_XX.h.t index 6b7883fdd4..5b996bd4d5 100644 --- a/gr-blocks/include/blocks/moving_average_XX.h.t +++ b/gr-blocks/include/blocks/moving_average_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output is the moving sum of the last N samples, scaled by the scale factor - * \ingroup filter_blk + * \ingroup level_controllers_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/multiply_XX.h.t b/gr-blocks/include/blocks/multiply_XX.h.t index 47ed3746c7..4ad25d35e9 100644 --- a/gr-blocks/include/blocks/multiply_XX.h.t +++ b/gr-blocks/include/blocks/multiply_XX.h.t @@ -33,8 +33,9 @@ namespace gr { /*! * \brief output = prod (input_0, input_1, ...) - * \ingroup math_blk + * \ingroup math_operators_blk * + * \details * Multiply across all input streams. */ class BLOCKS_API @NAME@ : virtual public gr_sync_block diff --git a/gr-blocks/include/blocks/multiply_cc.h b/gr-blocks/include/blocks/multiply_cc.h index 559fcda579..79533c2dc6 100644 --- a/gr-blocks/include/blocks/multiply_cc.h +++ b/gr-blocks/include/blocks/multiply_cc.h @@ -29,6 +29,13 @@ namespace gr { namespace blocks { + /*! + * \brief output = prod (input_0, input_1, ...) + * \ingroup math_operators_blk + * + * \details + * Multiply across all input streams. + */ class BLOCKS_API multiply_cc : virtual public gr_sync_block { public: diff --git a/gr-blocks/include/blocks/multiply_conjugate_cc.h b/gr-blocks/include/blocks/multiply_conjugate_cc.h index fc587ae2f7..7fa46f891e 100644 --- a/gr-blocks/include/blocks/multiply_conjugate_cc.h +++ b/gr-blocks/include/blocks/multiply_conjugate_cc.h @@ -29,6 +29,10 @@ namespace gr { namespace blocks { + /*! + * \brief Multiplies stream 0 by the complex conjugate of stream 1. + * \ingroup math_operators_blk + */ class BLOCKS_API multiply_conjugate_cc : virtual public gr_sync_block { public: diff --git a/gr-blocks/include/blocks/multiply_const_XX.h.t b/gr-blocks/include/blocks/multiply_const_XX.h.t index a7cd3a8583..4f5ac5c5a6 100644 --- a/gr-blocks/include/blocks/multiply_const_XX.h.t +++ b/gr-blocks/include/blocks/multiply_const_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input * constant - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/multiply_const_cc.h b/gr-blocks/include/blocks/multiply_const_cc.h index 9572eaec70..3469b4df17 100644 --- a/gr-blocks/include/blocks/multiply_const_cc.h +++ b/gr-blocks/include/blocks/multiply_const_cc.h @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input * complex constant - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API multiply_const_cc : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/multiply_const_ff.h b/gr-blocks/include/blocks/multiply_const_ff.h index d2d5e805cb..627e0c39a6 100644 --- a/gr-blocks/include/blocks/multiply_const_ff.h +++ b/gr-blocks/include/blocks/multiply_const_ff.h @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input * real constant - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API multiply_const_ff : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/multiply_ff.h b/gr-blocks/include/blocks/multiply_ff.h index 683b540bbd..ef3f5109bd 100644 --- a/gr-blocks/include/blocks/multiply_ff.h +++ b/gr-blocks/include/blocks/multiply_ff.h @@ -29,6 +29,13 @@ namespace gr { namespace blocks { + /*! + * \brief output = prod (input_0, input_1, ...) + * \ingroup math_operators_blk + * + * \details + * Multiply across all input streams. + */ class BLOCKS_API multiply_ff : virtual public gr_sync_block { public: diff --git a/gr-blocks/include/blocks/mute_XX.h.t b/gr-blocks/include/blocks/mute_XX.h.t index 2b1c8b9a4d..b9a394df2f 100644 --- a/gr-blocks/include/blocks/mute_XX.h.t +++ b/gr-blocks/include/blocks/mute_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input or zero if muted. - * \ingroup level_blk + * \ingroup level_controllers_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/nlog10_ff.h b/gr-blocks/include/blocks/nlog10_ff.h index cedd620fa0..7c4dfd8962 100644 --- a/gr-blocks/include/blocks/nlog10_ff.h +++ b/gr-blocks/include/blocks/nlog10_ff.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief output = n*log10(input) + k - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API nlog10_ff : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/not_XX.h.t b/gr-blocks/include/blocks/not_XX.h.t index e406c82dc3..fc06327722 100644 --- a/gr-blocks/include/blocks/not_XX.h.t +++ b/gr-blocks/include/blocks/not_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = ~input - * \ingroup math_blk + * \ingroup boolean_operators_blk * * bitwise boolean not of input streams. */ diff --git a/gr-blocks/include/blocks/null_sink.h b/gr-blocks/include/blocks/null_sink.h index c13a7552c6..8e772ab61f 100644 --- a/gr-blocks/include/blocks/null_sink.h +++ b/gr-blocks/include/blocks/null_sink.h @@ -33,7 +33,7 @@ namespace gr { /*! * \brief Bit bucket. Use as a termination point when a sink is * required and we don't want to do anything real. - * \ingroup sink_blk + * \ingroup misc_blk */ class BLOCKS_API null_sink : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/null_source.h b/gr-blocks/include/blocks/null_source.h index 904a0c1ba3..fc782c1cb5 100644 --- a/gr-blocks/include/blocks/null_source.h +++ b/gr-blocks/include/blocks/null_source.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief A source of zeros used mainly for testing. - * \ingroup source_blk + * \ingroup misc_blk */ class BLOCKS_API null_source : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/or_XX.h.t b/gr-blocks/include/blocks/or_XX.h.t index 8bc9a080f6..67afe54ea9 100644 --- a/gr-blocks/include/blocks/or_XX.h.t +++ b/gr-blocks/include/blocks/or_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input_0 | input_1 | , ... | input_N) - * \ingroup math_blk + * \ingroup boolean_operators_blk * * Bitwise boolean or across all input streams. */ diff --git a/gr-blocks/include/blocks/pack_k_bits_bb.h b/gr-blocks/include/blocks/pack_k_bits_bb.h index 5bf71c9c3e..41ae4bc418 100644 --- a/gr-blocks/include/blocks/pack_k_bits_bb.h +++ b/gr-blocks/include/blocks/pack_k_bits_bb.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Converts a stream of bytes with 1 bit in the LSB to a * byte with k relevent bits. - * \ingroup converter_blk + * \ingroup byte_operators_blk */ class BLOCKS_API pack_k_bits_bb : virtual public gr_sync_decimator { diff --git a/gr-blocks/include/blocks/packed_to_unpacked_XX.h.t b/gr-blocks/include/blocks/packed_to_unpacked_XX.h.t index c00a27527e..d8edba2297 100644 --- a/gr-blocks/include/blocks/packed_to_unpacked_XX.h.t +++ b/gr-blocks/include/blocks/packed_to_unpacked_XX.h.t @@ -34,8 +34,9 @@ namespace gr { /*! * \brief Convert a stream of packed bytes or shorts to stream of unpacked bytes or shorts. - * \ingroup converter_blk + * \ingroup byte_operators_blk * + * \details * input: stream of @I_TYPE@; output: stream of @O_TYPE@ * * This is the inverse of gr::blocks::unpacked_to_packed_XX. diff --git a/gr-blocks/include/blocks/patterned_interleaver.h b/gr-blocks/include/blocks/patterned_interleaver.h index cfcdac6e73..01e9a0d58f 100644 --- a/gr-blocks/include/blocks/patterned_interleaver.h +++ b/gr-blocks/include/blocks/patterned_interleaver.h @@ -1,3 +1,25 @@ +/* -*- c++ -*- */ +/* + * Copyright 2013 Free Software Foundation, Inc. + * + * This file is part of GNU Radio + * + * GNU Radio is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 3, or (at your option) + * any later version. + * + * GNU Radio is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with GNU Radio; see the file COPYING. If not, write to + * the Free Software Foundation, Inc., 51 Franklin Street, + * Boston, MA 02110-1301, USA. + */ + #ifndef INCLUDED_BLOCKS_PATTERNED_INTERLEAVER_H #define INCLUDED_BLOCKS_PATTERNED_INTERLEAVER_H @@ -7,17 +29,26 @@ namespace gr { namespace blocks { + /*! + * \brief Interleave items based on the provided vector \p pattern. + * \ingroup stream_operators_blk + */ class BLOCKS_API patterned_interleaver : virtual public gr_block { public: - typedef boost::shared_ptr<patterned_interleaver> sptr; + /*! + * Make a patterned interleaver block. + * + * \param itemsize stream itemsize + * \param pattern vector that represents the interleaving pattern + */ static sptr make(size_t itemsize, std::vector<int> pattern); }; } } -#endif +#endif /* INCLUDED_BLOCKS_PATTERNED_INTERLEAVER_H */ diff --git a/gr-blocks/include/blocks/pdu_to_tagged_stream.h b/gr-blocks/include/blocks/pdu_to_tagged_stream.h index cf64f41dc2..6a26673149 100644 --- a/gr-blocks/include/blocks/pdu_to_tagged_stream.h +++ b/gr-blocks/include/blocks/pdu_to_tagged_stream.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Turns received PDUs into a tagged stream of items - * \ingroup source_blk + * \ingroup message_tools_blk */ class BLOCKS_API pdu_to_tagged_stream : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/peak_detector2_fb.h b/gr-blocks/include/blocks/peak_detector2_fb.h index 71afc3287b..aa30d46a04 100644 --- a/gr-blocks/include/blocks/peak_detector2_fb.h +++ b/gr-blocks/include/blocks/peak_detector2_fb.h @@ -31,19 +31,12 @@ 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. A separate debug output may be connected, to view the * internal EWMA described below. - * - * \param threshold_factor_rise The threshold factor determins - * when a peak is present. An EWMA average of the signal is - * calculated and when the value of the signal goes over - * threshold_factor_rise*average, we call the peak. - * \param look_ahead The look-ahead value is used when the - * threshold is found to locate the peak within this range. - * \param alpha The gain value of a single-pole moving average filter. */ class BLOCKS_API peak_detector2_fb : virtual public gr_sync_block { @@ -51,6 +44,17 @@ namespace gr { // gr::blocks::peak_detector2_fb::sptr typedef boost::shared_ptr<peak_detector2_fb> sptr; + /*! + * Build a peak detector block with float in, byte out. + * + * \param threshold_factor_rise The threshold factor determins + * when a peak is present. An EWMA average of the signal is + * calculated and when the value of the signal goes over + * threshold_factor_rise*average, we call the peak. + * \param look_ahead The look-ahead value is used when the + * threshold is found to locate the peak within this range. + * \param alpha The gain value of a single-pole moving average filter. + */ static sptr make(float threshold_factor_rise=7, int look_ahead=1000, float alpha=0.001); diff --git a/gr-blocks/include/blocks/peak_detector_XX.h.t b/gr-blocks/include/blocks/peak_detector_XX.h.t index fead53d208..8d42f42ea8 100644 --- a/gr-blocks/include/blocks/peak_detector_XX.h.t +++ b/gr-blocks/include/blocks/peak_detector_XX.h.t @@ -33,8 +33,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-blocks/include/blocks/plateau_detector_fb.h b/gr-blocks/include/blocks/plateau_detector_fb.h index 041f9c1baf..119262d396 100644 --- a/gr-blocks/include/blocks/plateau_detector_fb.h +++ b/gr-blocks/include/blocks/plateau_detector_fb.h @@ -32,7 +32,9 @@ namespace gr { /*! * \brief Detects a plateau and marks the middle. + * \ingroup peak_detectors_blk * + * \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 +50,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 level_blk - * */ class BLOCKS_API plateau_detector_fb : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/probe_rate.h b/gr-blocks/include/blocks/probe_rate.h index 3401d2acd1..fc0b9f29d4 100644 --- a/gr-blocks/include/blocks/probe_rate.h +++ b/gr-blocks/include/blocks/probe_rate.h @@ -31,6 +31,7 @@ namespace gr { /*! * \brief throughput measurement + * \ingroup measurement_tools_blk */ class BLOCKS_API probe_rate : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/probe_signal_X.h.t b/gr-blocks/include/blocks/probe_signal_X.h.t index 01b7bad0c4..fb0d84bb41 100644 --- a/gr-blocks/include/blocks/probe_signal_X.h.t +++ b/gr-blocks/include/blocks/probe_signal_X.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief Sink that allows a sample to be grabbed from Python. - * \ingroup sink_blk + * \ingroup measurement_tools_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/probe_signal_vX.h.t b/gr-blocks/include/blocks/probe_signal_vX.h.t index 487f280db4..77462dc658 100644 --- a/gr-blocks/include/blocks/probe_signal_vX.h.t +++ b/gr-blocks/include/blocks/probe_signal_vX.h.t @@ -35,6 +35,7 @@ namespace gr { /*! * \brief Sink that allows a vector of samples to be grabbed from Python. * \ingroup sink_blk + * \ingroup measurement_tools_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/regenerate_bb.h b/gr-blocks/include/blocks/regenerate_bb.h index 3063e70a7f..a2cc76737e 100644 --- a/gr-blocks/include/blocks/regenerate_bb.h +++ b/gr-blocks/include/blocks/regenerate_bb.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Detect the peak of a signal and repeat every period samples - * \ingroup level_blk + * \ingroup stream_operators_blk * + * \details * 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 regenerations have occurred. diff --git a/gr-blocks/include/blocks/repack_bits_bb.h b/gr-blocks/include/blocks/repack_bits_bb.h index 9ade0a4353..268e4eefc5 100644 --- a/gr-blocks/include/blocks/repack_bits_bb.h +++ b/gr-blocks/include/blocks/repack_bits_bb.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Pack \p k bits from the input stream onto \p k bits of the output stream. - * \ingroup blocks + * \ingroup byte_operators_blk * + * \details * No bits are lost here; any value for k and l (within [1, 8]) is allowed. * On every fresh input byte, it starts reading on the LSB, and starts copying * to the LSB as well. diff --git a/gr-blocks/include/blocks/repeat.h b/gr-blocks/include/blocks/repeat.h index 3f9f8e6fc2..b353205541 100644 --- a/gr-blocks/include/blocks/repeat.h +++ b/gr-blocks/include/blocks/repeat.h @@ -30,18 +30,21 @@ namespace gr { namespace blocks { /*! - * \brief repeat each input 'interp' times - * \ingroup slicedice_blk - * \param itemsize stream itemsize - * \param interp number of times to repeat + * \brief repeat each input \p repeat times + * \ingroup stream_operators_blk */ class BLOCKS_API repeat : virtual public gr_sync_interpolator { public: - // gr::blocks::repeat::sptr typedef boost::shared_ptr<repeat> sptr; + /*! + * Make a repeat block. + * + * \param itemsize stream itemsize + * \param repeat number of times to repeat the input + */ static sptr make(size_t itemsize, int repeat); }; diff --git a/gr-blocks/include/blocks/rms_cf.h b/gr-blocks/include/blocks/rms_cf.h index e73be6923a..94a17f7a67 100644 --- a/gr-blocks/include/blocks/rms_cf.h +++ b/gr-blocks/include/blocks/rms_cf.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief RMS average power - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API rms_cf : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/rms_ff.h b/gr-blocks/include/blocks/rms_ff.h index b945096907..e202d79f2c 100644 --- a/gr-blocks/include/blocks/rms_ff.h +++ b/gr-blocks/include/blocks/rms_ff.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief RMS average power - * \ingroup math_blk + * \ingroup math_operators_blk */ class BLOCKS_API rms_ff : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/sample_and_hold_XX.h.t b/gr-blocks/include/blocks/sample_and_hold_XX.h.t index 3266523efb..0d2ecdc5d7 100644 --- a/gr-blocks/include/blocks/sample_and_hold_XX.h.t +++ b/gr-blocks/include/blocks/sample_and_hold_XX.h.t @@ -33,8 +33,9 @@ namespace gr { /*! * \brief sample and hold circuit - * \ingroup level_blk + * \ingroup level_controllers_blk * + * \details * Samples the data stream (input stream 0) and holds the value if * the control signal is 1 (intput stream 1). */ diff --git a/gr-blocks/include/blocks/short_to_char.h b/gr-blocks/include/blocks/short_to_char.h index eeb053b0ec..09e784f101 100644 --- a/gr-blocks/include/blocks/short_to_char.h +++ b/gr-blocks/include/blocks/short_to_char.h @@ -30,18 +30,20 @@ namespace gr { namespace blocks { /*! - * \brief Convert stream of shorts to a stream of chars - * \ingroup converter_blk - * - * \param vlen vector length of data streams. + * \brief Convert stream of shorts to a stream of chars. + * \ingroup type_converters_blk */ class BLOCKS_API short_to_char : virtual public gr_sync_block { public: - // gr::blocks::short_to_char_ff::sptr typedef boost::shared_ptr<short_to_char> sptr; + /*! + * Build a short to char block. + * + * \param vlen vector length of data streams. + */ static sptr make(size_t vlen=1); }; diff --git a/gr-blocks/include/blocks/short_to_float.h b/gr-blocks/include/blocks/short_to_float.h index c26addcd01..ec85e892ed 100644 --- a/gr-blocks/include/blocks/short_to_float.h +++ b/gr-blocks/include/blocks/short_to_float.h @@ -31,18 +31,20 @@ namespace gr { /*! * \brief Convert stream of shorts to a stream of floats - * \ingroup converter_blk - * - * \param vlen vector length of data streams. - * \param scale a scalar divider to change the output signal scale. + * \ingroup type_converters_blk */ class BLOCKS_API short_to_float : virtual public gr_sync_block { public: - // gr::blocks::short_to_float_ff::sptr typedef boost::shared_ptr<short_to_float> sptr; + /*! + * Build a short to float block. + * + * \param vlen vector length of data streams. + * \param scale a scalar divider to change the output signal scale. + */ static sptr make(size_t vlen=1, float scale=1.0); /*! diff --git a/gr-blocks/include/blocks/skiphead.h b/gr-blocks/include/blocks/skiphead.h index e6745af8ea..27a8afea92 100644 --- a/gr-blocks/include/blocks/skiphead.h +++ b/gr-blocks/include/blocks/skiphead.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief skips the first N items, from then on copies items to the output - * \ingroup slicedice_blk + * \ingroup misc_blk * + * \details * Useful for building test cases and sources which have metadata * or junk at the start */ diff --git a/gr-blocks/include/blocks/socket_pdu.h b/gr-blocks/include/blocks/socket_pdu.h index 0ed64a2557..f72d303c75 100644 --- a/gr-blocks/include/blocks/socket_pdu.h +++ b/gr-blocks/include/blocks/socket_pdu.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Creates socket interface and translates traffic to PDUs - * \ingroup net_blk + * \ingroup networking_tools_blk */ class BLOCKS_API socket_pdu : virtual public gr_block { diff --git a/gr-blocks/include/blocks/stream_mux.h b/gr-blocks/include/blocks/stream_mux.h index 58d564f9fe..0e29aab364 100644 --- a/gr-blocks/include/blocks/stream_mux.h +++ b/gr-blocks/include/blocks/stream_mux.h @@ -33,7 +33,9 @@ namespace gr { /*! * \brief Stream muxing block to multiplex many streams into * one with a specified format. + * \ingroup stream_operators_blk * + * \details * Muxes N streams together producing an output stream that * contains N0 items from the first stream, N1 items from the second, * etc. and repeats: @@ -50,7 +52,6 @@ namespace gr { /*! * \brief Creates a stream muxing block to multiplex many streams into * one with a specified format. - * \ingroup converter_blk * * \param itemsize the item size of the stream * \param lengths a vector (list/tuple) specifying the number of diff --git a/gr-blocks/include/blocks/stream_to_streams.h b/gr-blocks/include/blocks/stream_to_streams.h index fc39f1687f..e9b257575f 100644 --- a/gr-blocks/include/blocks/stream_to_streams.h +++ b/gr-blocks/include/blocks/stream_to_streams.h @@ -31,18 +31,24 @@ namespace gr { /*! * \brief convert a stream of items into a N streams of items - * \ingroup slicedice_blk + * \ingroup stream_operators_blk * + * \details * Converts a stream of N items into N streams of 1 item. * Repeat ad infinitum. */ class BLOCKS_API stream_to_streams : virtual public gr_sync_decimator { public: - // gr::blocks::stream_to_streams::sptr typedef boost::shared_ptr<stream_to_streams> sptr; + /*! + * Make a stream-to-streams block. + * + * \param itemsize the item size of the stream + * \param nstreams number of streams to split input into + */ static sptr make(size_t itemsize, size_t nstreams); }; diff --git a/gr-blocks/include/blocks/stream_to_vector.h b/gr-blocks/include/blocks/stream_to_vector.h index 8311eb3506..98325500b1 100644 --- a/gr-blocks/include/blocks/stream_to_vector.h +++ b/gr-blocks/include/blocks/stream_to_vector.h @@ -31,15 +31,20 @@ namespace gr { /*! * \brief convert a stream of items into a stream of blocks containing nitems_per_block - * \ingroup slicedice_blk + * \ingroup stream_operators_blk */ class BLOCKS_API stream_to_vector : virtual public gr_sync_decimator { public: - // gr::blocks::stream_to_vector::sptr typedef boost::shared_ptr<stream_to_vector> sptr; + /*! + * Make a stream-to-vector block. + * + * \param itemsize the item size of the stream + * \param nitems_per_block number of items to but into each vector (vector size) + */ static sptr make(size_t itemsize, size_t nitems_per_block); }; diff --git a/gr-blocks/include/blocks/streams_to_stream.h b/gr-blocks/include/blocks/streams_to_stream.h index 01dcd1be33..e677a18e2a 100644 --- a/gr-blocks/include/blocks/streams_to_stream.h +++ b/gr-blocks/include/blocks/streams_to_stream.h @@ -31,18 +31,24 @@ namespace gr { /*! * \brief Convert N streams of 1 item into a 1 stream of N items - * \ingroup slicedice_blk + * \ingroup stream_operators_blk * + * \details * Convert N streams of 1 item into 1 stream of N items. * Repeat ad infinitum. */ class BLOCKS_API streams_to_stream : virtual public gr_sync_interpolator { public: - // gr::blocks::streams_to_stream::sptr typedef boost::shared_ptr<streams_to_stream> sptr; + /*! + * Make a streams-to-stream block. + * + * \param itemsize the item size of the stream + * \param nstreams number of streams to combine + */ static sptr make(size_t itemsize, size_t nstreams); }; diff --git a/gr-blocks/include/blocks/streams_to_vector.h b/gr-blocks/include/blocks/streams_to_vector.h index ad55ac31f1..f4df16c9f4 100644 --- a/gr-blocks/include/blocks/streams_to_vector.h +++ b/gr-blocks/include/blocks/streams_to_vector.h @@ -31,15 +31,20 @@ namespace gr { /*! * \brief convert N streams of items to 1 stream of vector length N - * \ingroup slicedice_blk + * \ingroup stream_operators_blk */ class BLOCKS_API streams_to_vector : virtual public gr_sync_block { public: - // gr::blocks::streams_to_vector::sptr typedef boost::shared_ptr<streams_to_vector> sptr; + /*! + * Make a stream-to-vector block. + * + * \param itemsize the item size of the stream + * \param nstreams number of streams to combine into a vector (vector size) + */ static sptr make(size_t itemsize, size_t nstreams); }; diff --git a/gr-blocks/include/blocks/stretch_ff.h b/gr-blocks/include/blocks/stretch_ff.h index 5f98452a41..47bcb9ee87 100644 --- a/gr-blocks/include/blocks/stretch_ff.h +++ b/gr-blocks/include/blocks/stretch_ff.h @@ -33,7 +33,7 @@ namespace gr { * \brief adjust y-range of an input vector by mapping to range * (max-of-input, stipulated-min). Primarily for spectral * signature matching by normalizing spectrum dynamic ranges. - * \ingroup misc_blk + * \ingroup stream_operators_blk */ class BLOCKS_API stretch_ff : virtual public gr_sync_block { @@ -43,9 +43,10 @@ namespace gr { /*! * \brief Make a stretch block. + * * \param lo Set low value for range. * \param vlen vector length of input stream. - */ + */ static sptr make(float lo, size_t vlen=1); virtual float lo() const = 0; diff --git a/gr-blocks/include/blocks/sub_XX.h.t b/gr-blocks/include/blocks/sub_XX.h.t index 8202ac54b1..db854346f6 100644 --- a/gr-blocks/include/blocks/sub_XX.h.t +++ b/gr-blocks/include/blocks/sub_XX.h.t @@ -33,8 +33,9 @@ namespace gr { /*! * \brief output = input_0 - input_1 - ...) - * \ingroup math_blk + * \ingroup math_operators_blk * + * \details * Subtract across all input streams. */ class BLOCKS_API @NAME@ : virtual public gr_sync_block diff --git a/gr-blocks/include/blocks/tag_debug.h b/gr-blocks/include/blocks/tag_debug.h index 9d27a26ecd..8093a6152f 100644 --- a/gr-blocks/include/blocks/tag_debug.h +++ b/gr-blocks/include/blocks/tag_debug.h @@ -31,8 +31,11 @@ namespace gr { /*! * \brief Bit bucket that prints out any tag received. - * \ingroup sink_blk + * \ingroup measurement_tools_blk + * \ingroup stream_tag_tools_blk + * \ingroup debug_tools_blk * + * \details * This block collects all tags sent to it on all input ports and * displays them to stdout in a formatted way. The \p name * parameter is used to identify which debug sink generated the diff --git a/gr-blocks/include/blocks/tagged_file_sink.h b/gr-blocks/include/blocks/tagged_file_sink.h index 62da72f789..2014b66964 100644 --- a/gr-blocks/include/blocks/tagged_file_sink.h +++ b/gr-blocks/include/blocks/tagged_file_sink.h @@ -31,8 +31,10 @@ namespace gr { /*! * \brief A file sink that uses tags to save files. - * \ingroup sink_blk + * \ingroup file_operators_blk + * \ingroup stream_tag_tools_blk * + * \details * The sink uses a tag with the key 'burst' to trigger the saving * of the burst data to a new file. If the value of this tag is * True, it will open a new file and start writing all incoming diff --git a/gr-blocks/include/blocks/tagged_stream_mux.h b/gr-blocks/include/blocks/tagged_stream_mux.h index d271cf890f..2fa9b3f01d 100644 --- a/gr-blocks/include/blocks/tagged_stream_mux.h +++ b/gr-blocks/include/blocks/tagged_stream_mux.h @@ -30,8 +30,10 @@ namespace gr { /*! * \brief Combines tagged streams. + * \ingroup stream_operators_blk * - * Takes N streams as input. Each stream is tagged with packet lengths. + * \details + * Takes N streams as input. Each stream is tagged with packet lengths. * Packets are output sequentially from each input stream. * * The output signal has a new length tag, which is the sum of all @@ -39,8 +41,6 @@ namespace gr { * * All other tags are propagated as expected, i.e. they stay associated * with the same input item. - * - * \ingroup blocks */ class BLOCKS_API tagged_stream_mux : virtual public gr_tagged_stream_block { @@ -48,6 +48,8 @@ namespace gr { typedef boost::shared_ptr<tagged_stream_mux> sptr; /*! + * Make a tagged stream mux block. + * * \param itemsize Items size (number of bytes per item) * \param lengthtagname Length tag key */ diff --git a/gr-blocks/include/blocks/tagged_stream_to_pdu.h b/gr-blocks/include/blocks/tagged_stream_to_pdu.h index 32e72a7879..b990c44ab1 100644 --- a/gr-blocks/include/blocks/tagged_stream_to_pdu.h +++ b/gr-blocks/include/blocks/tagged_stream_to_pdu.h @@ -32,7 +32,7 @@ namespace gr { /*! * \brief Turns received stream data and tags into PDUs - * \ingroup source_blk + * \ingroup message_tools_blk */ class BLOCKS_API tagged_stream_to_pdu : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/threshold_ff.h b/gr-blocks/include/blocks/threshold_ff.h index 900e5c5bdb..6a20e7ed43 100644 --- a/gr-blocks/include/blocks/threshold_ff.h +++ b/gr-blocks/include/blocks/threshold_ff.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Output a 1 or zero based on a threshold value. - * \ingroup misc_blk + * \ingroup level_controllers_blk * + * \details * Test the incoming signal against a threshold. If the signal * excedes the \p hi value, it will output a 1 until the signal * falls below the \p lo value. diff --git a/gr-blocks/include/blocks/throttle.h b/gr-blocks/include/blocks/throttle.h index 20d8037e10..d9d9f311c4 100644 --- a/gr-blocks/include/blocks/throttle.h +++ b/gr-blocks/include/blocks/throttle.h @@ -34,6 +34,7 @@ namespace gr { * not exceed samples_per_sec. * \ingroup misc_blk * + * \details * input: one stream of itemsize; output: one stream of itemsize * * N.B. this should only be used in GUI apps where there is no diff --git a/gr-blocks/include/blocks/transcendental.h b/gr-blocks/include/blocks/transcendental.h index f8a0d5d805..a3a483e8f3 100644 --- a/gr-blocks/include/blocks/transcendental.h +++ b/gr-blocks/include/blocks/transcendental.h @@ -32,7 +32,9 @@ namespace gr { /*! * \brief A block that performs various transcendental math operations. + * \ingroup math_operators_blk * + * \details * Possible function names can be found in the cmath library. IO * may be either complex or real, double or single precision. * diff --git a/gr-blocks/include/blocks/tuntap_pdu.h b/gr-blocks/include/blocks/tuntap_pdu.h index 70abb0bd5b..afa03cfb82 100644 --- a/gr-blocks/include/blocks/tuntap_pdu.h +++ b/gr-blocks/include/blocks/tuntap_pdu.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Creates TUNTAP interface and translates traffic to PDUs - * \ingroup net_blk + * \ingroup networking_tools_blk */ class BLOCKS_API tuntap_pdu : virtual public gr_block { diff --git a/gr-blocks/include/blocks/uchar_to_float.h b/gr-blocks/include/blocks/uchar_to_float.h index 033037e498..725c4e5021 100644 --- a/gr-blocks/include/blocks/uchar_to_float.h +++ b/gr-blocks/include/blocks/uchar_to_float.h @@ -31,15 +31,17 @@ namespace gr { /*! * \brief Convert stream of unsigned chars to a stream of floats - * \ingroup converter_blk + * \ingroup type_converters_blk */ class BLOCKS_API uchar_to_float : virtual public gr_sync_block { public: - // gr::blocks::uchar_to_float_ff::sptr typedef boost::shared_ptr<uchar_to_float> sptr; + /*! + * Build a uchar to float block. + */ static sptr make(); }; diff --git a/gr-blocks/include/blocks/udp_sink.h b/gr-blocks/include/blocks/udp_sink.h index 69c5f0ffae..9530217515 100644 --- a/gr-blocks/include/blocks/udp_sink.h +++ b/gr-blocks/include/blocks/udp_sink.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Write stream to an UDP socket. - * \ingroup sink_blk + * \ingroup networking_tools_blk */ class BLOCKS_API udp_sink : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/udp_source.h b/gr-blocks/include/blocks/udp_source.h index b72db30db0..4681b0b54a 100644 --- a/gr-blocks/include/blocks/udp_source.h +++ b/gr-blocks/include/blocks/udp_source.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Read stream from an UDP socket. - * \ingroup source_blk + * \ingroup networking_tools_blk */ class BLOCKS_API udp_source : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/unpack_k_bits_bb.h b/gr-blocks/include/blocks/unpack_k_bits_bb.h index b716ded1d3..a36cfb50e4 100644 --- a/gr-blocks/include/blocks/unpack_k_bits_bb.h +++ b/gr-blocks/include/blocks/unpack_k_bits_bb.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Converts a byte with k relevent bits to k output bytes with 1 bit in the LSB. - * \ingroup converter_blk + * \ingroup byte_operators_blk */ class BLOCKS_API unpack_k_bits_bb : virtual public gr_sync_interpolator { diff --git a/gr-blocks/include/blocks/unpacked_to_packed_XX.h.t b/gr-blocks/include/blocks/unpacked_to_packed_XX.h.t index d570785a68..649b9082fb 100644 --- a/gr-blocks/include/blocks/unpacked_to_packed_XX.h.t +++ b/gr-blocks/include/blocks/unpacked_to_packed_XX.h.t @@ -34,8 +34,9 @@ namespace gr { /*! * \brief Convert a stream of unpacked bytes or shorts into a stream of packed bytes or shorts. - * \ingroup converter_blk + * \ingroup byte_operators_blk * + * \details * input: stream of @I_TYPE@; output: stream of @O_TYPE@ * * This is the inverse of gr::blocks::packed_to_unpacked_XX. diff --git a/gr-blocks/include/blocks/vco_f.h b/gr-blocks/include/blocks/vco_f.h index 0a5bf97d1f..7245f4c96b 100644 --- a/gr-blocks/include/blocks/vco_f.h +++ b/gr-blocks/include/blocks/vco_f.h @@ -31,8 +31,10 @@ namespace gr { /*! * \brief VCO - Voltage controlled oscillator - * \ingroup misc + * \ingroup modulators_blk + * \ingroup waveform_generators_blk * + * \details * input: float stream of control voltages; output: float oscillator output */ class BLOCKS_API vco_f : virtual public gr_sync_block diff --git a/gr-blocks/include/blocks/vector_insert_X.h.t b/gr-blocks/include/blocks/vector_insert_X.h.t index aeb4a5248a..c45e5152fa 100644 --- a/gr-blocks/include/blocks/vector_insert_X.h.t +++ b/gr-blocks/include/blocks/vector_insert_X.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief source of @TYPE@'s that gets its data from a vector - * \ingroup source_blk + * \ingroup stream_operators_blk */ class BLOCKS_API @NAME@ : virtual public gr_block { @@ -41,6 +41,13 @@ namespace gr { // gr::blocks::@NAME@::sptr typedef boost::shared_ptr<@NAME@> sptr; + /*! + * Make vector insert block. + * + * \param data vector of data to insert + * \param periodicity number of samples between when to send \p data + * \param offset initial item offset of first insert + */ static sptr make(const std::vector<@TYPE@> &data, int periodicity, int offset=0); diff --git a/gr-blocks/include/blocks/vector_map.h b/gr-blocks/include/blocks/vector_map.h index 64c8744975..77a7fc1865 100644 --- a/gr-blocks/include/blocks/vector_map.h +++ b/gr-blocks/include/blocks/vector_map.h @@ -34,6 +34,7 @@ namespace gr { * \brief Maps elements from a set of input vectors to a set of output vectors. * \ingroup slicedice_blk * + * \details * If in[i] is the input vector in the i'th stream then the output * vector in the j'th stream is: * diff --git a/gr-blocks/include/blocks/vector_sink_X.h.t b/gr-blocks/include/blocks/vector_sink_X.h.t index d15c795721..1d17700f5f 100644 --- a/gr-blocks/include/blocks/vector_sink_X.h.t +++ b/gr-blocks/include/blocks/vector_sink_X.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief @TYPE@ sink that writes to a vector - * \ingroup sink_blk + * \ingroup debug_tools_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/vector_source_X.h.t b/gr-blocks/include/blocks/vector_source_X.h.t index c68b638e62..8d3693f3ee 100644 --- a/gr-blocks/include/blocks/vector_source_X.h.t +++ b/gr-blocks/include/blocks/vector_source_X.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief source of @TYPE@'s that gets its data from a vector - * \ingroup source_blk + * \ingroup misc_blk */ class BLOCKS_API @NAME@ : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/vector_to_stream.h b/gr-blocks/include/blocks/vector_to_stream.h index 1e72f6d50b..2a02704287 100644 --- a/gr-blocks/include/blocks/vector_to_stream.h +++ b/gr-blocks/include/blocks/vector_to_stream.h @@ -31,15 +31,20 @@ namespace gr { /*! * \brief convert a stream of blocks of nitems_per_block items into a stream of items - * \ingroup slicedice_blk + * \ingroup stream_operators_blk */ class BLOCKS_API vector_to_stream : virtual public gr_sync_interpolator { public: - // gr::blocks::vector_to_stream::sptr typedef boost::shared_ptr<vector_to_stream> sptr; + /*! + * Make vector-to-stream block + * + * \param itemsize the item size of the stream + * \param nitems_per_block number of items per vector (vector size) + */ static sptr make(size_t itemsize, size_t nitems_per_block); }; diff --git a/gr-blocks/include/blocks/vector_to_streams.h b/gr-blocks/include/blocks/vector_to_streams.h index 1bc0758797..364bc9afbd 100644 --- a/gr-blocks/include/blocks/vector_to_streams.h +++ b/gr-blocks/include/blocks/vector_to_streams.h @@ -31,15 +31,21 @@ namespace gr { /*! * \brief Convert 1 stream of vectors of length N to N streams of items - * \ingroup slicedice_blk + * \ingroup stream_operators_blk */ class BLOCKS_API vector_to_streams : virtual public gr_sync_block { public: - // gr::blocks::vector_to_streams::sptr typedef boost::shared_ptr<vector_to_streams> sptr; + /*! + * Make vector-to-streams block + * + * \param itemsize the item size of the stream + * \param nstreams number of items per vector (vector size and + * number of streams produced) + */ static sptr make(size_t itemsize, size_t nstreams); }; diff --git a/gr-blocks/include/blocks/wavfile.h b/gr-blocks/include/blocks/wavfile.h index b852c01e2d..719ef92253 100644 --- a/gr-blocks/include/blocks/wavfile.h +++ b/gr-blocks/include/blocks/wavfile.h @@ -55,6 +55,7 @@ namespace gr { /*! * \brief Read one sample from an open WAV file at the current position. * + * \details * Takes care of endianness. */ short int @@ -77,6 +78,7 @@ namespace gr { /*! * \brief Write one sample to an open WAV file at the current position. * + * \details * Takes care of endianness. */ void @@ -86,6 +88,7 @@ namespace gr { /*! * \brief Complete a WAV header * + * \details * Note: The stream position is changed during this function. If * anything needs to be written to the WAV file after calling this * function (which shouldn't happen), you need to fseek() to the diff --git a/gr-blocks/include/blocks/wavfile_sink.h b/gr-blocks/include/blocks/wavfile_sink.h index b095191d07..f380e055a2 100644 --- a/gr-blocks/include/blocks/wavfile_sink.h +++ b/gr-blocks/include/blocks/wavfile_sink.h @@ -31,11 +31,11 @@ namespace gr { /*! * \brief Write stream to a Microsoft PCM (.wav) file. + * \ingroup audio_blk * + * \details * Values must be floats within [-1;1]. * Check gr_make_wavfile_sink() for extra info. - * - * \ingroup sink_blk */ class BLOCKS_API wavfile_sink : virtual public gr_sync_block { @@ -44,10 +44,10 @@ namespace gr { typedef boost::shared_ptr<wavfile_sink> sptr; /* - * \p filename The .wav file to be opened - * \p n_channels Number of channels (2 = stereo or I/Q output) - * \p sample_rate Sample rate [S/s] - * \p bits_per_sample 16 or 8 bit, default is 16 + * \param filename The .wav file to be opened + * \param n_channels Number of channels (2 = stereo or I/Q output) + * \param sample_rate Sample rate [S/s] + * \param bits_per_sample 16 or 8 bit, default is 16 */ static sptr make(const char *filename, int n_channels, diff --git a/gr-blocks/include/blocks/wavfile_source.h b/gr-blocks/include/blocks/wavfile_source.h index 46cb82b698..5332a0c20e 100644 --- a/gr-blocks/include/blocks/wavfile_source.h +++ b/gr-blocks/include/blocks/wavfile_source.h @@ -31,11 +31,11 @@ namespace gr { /*! * \brief Read stream from a Microsoft PCM (.wav) file, output floats + * \ingroup audio_blk * + * \details * Unless otherwise called, values are within [-1;1]. * Check gr_make_wavfile_source() for extra info. - * - * \ingroup source_blk */ class BLOCKS_API wavfile_source : virtual public gr_sync_block { diff --git a/gr-blocks/include/blocks/xor_XX.h.t b/gr-blocks/include/blocks/xor_XX.h.t index ba0c508f6e..a890dbaf89 100644 --- a/gr-blocks/include/blocks/xor_XX.h.t +++ b/gr-blocks/include/blocks/xor_XX.h.t @@ -33,7 +33,7 @@ namespace gr { /*! * \brief output = input_0 ^ input_1 ^ , ... ^ input_N) - * \ingroup math_blk + * \ingroup boolean_operators_blk * * Bitwise boolean xor across all input streams. */ |