[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Commit-gnuradio] r11085 - in gnuradio/trunk: docs/doxygen/other gnuradi
|
From: |
eb |
|
Subject: |
[Commit-gnuradio] r11085 - in gnuradio/trunk: docs/doxygen/other gnuradio-core/src/lib/filter gnuradio-core/src/lib/general gnuradio-core/src/lib/gengen gnuradio-core/src/lib/io gnuradio-core/src/lib/runtime gr-cvsd-vocoder/src/lib gr-gcell/src gr-gsm-fr-vocoder/src/lib gr-usrp/src gr-usrp2/src usrp/host/lib/legacy usrp2/host/include/usrp2 usrp2/host/lib |
|
Date: |
Fri, 22 May 2009 10:11:17 -0600 (MDT) |
Author: eb
Date: 2009-05-22 10:11:15 -0600 (Fri, 22 May 2009)
New Revision: 11085
Modified:
gnuradio/trunk/docs/doxygen/other/group_defs.dox
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_cma_equalizer_cc.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fft_filter_fff.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_filter_delay_fc.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_goertzel_fc.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_hilbert_fc.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gri_goertzel.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc2_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc2_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_bin_statistics_f.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_binary_slicer_fb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_bytes_to_syms.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_char_to_float.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_check_counting_s.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_complex_to_xxx.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_conjugate_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_cpfsk_bc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_deinterleave.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_delay.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_diff_decoder_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_diff_encoder_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_dpll_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vcc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vfc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_char.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_complex.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_short.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_uchar.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_framer_sink_1.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_fxpt.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_glfsr_source_b.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_glfsr_source_f.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_head.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_interleave.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_iqcomp_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_keep_one_in_n.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_kludge_copy.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_lms_dfe_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_map_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_math.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_nlog10_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_nop.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_null_sink.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_null_source.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pa_2x2_phase_combiner.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_packet_sink.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_peak_detector2_fb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_phase_modulator_fc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_mpsk_snr_c.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_signal_f.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_random.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_regenerate_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_repeat.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_rms_cf.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_rms_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_scrambler_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_short_to_float.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_correlator.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_skiphead.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_mux.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_to_streams.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_to_vector.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_streams_to_stream.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_streams_to_vector.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_stretch_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_test.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_threshold_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_throttle.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_uchar_to_float.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_vco_f.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_vector_to_stream.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_vector_to_streams.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_wavelet_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_wvps_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc2_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc2_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_fft.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_glfsr.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr_15_1_0.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr_32k.h
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_const_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_const_vXX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_and_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_and_const_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_chunks_to_symbols_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_divide_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_integrate_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_const_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_const_vXX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_mute_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_noise_source_X.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_not_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_or_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_packed_to_unpacked_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_peak_detector_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sig_source_X.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_unpacked_to_packed_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_vector_sink_X.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_vector_source_X.h.t
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_xor_XX.h.t
gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_descriptor_sink.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_descriptor_source.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_sink.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_source.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_histo_sink_f.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_message_sink.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_message_source.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_oscope_sink_f.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_oscope_sink_x.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_udp_sink.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_udp_source.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_wavfile_sink.h
gnuradio/trunk/gnuradio-core/src/lib/io/gr_wavfile_source.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_basic_block.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_block.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_flowgraph.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2_detail.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_io_signature.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_block.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_decimator.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_top_block.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h
gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h
gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h
gnuradio/trunk/gr-gcell/src/gcell_fft_vcc.h
gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h
gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h
gnuradio/trunk/gr-usrp/src/usrp_sink_c.h
gnuradio/trunk/gr-usrp/src/usrp_sink_s.h
gnuradio/trunk/gr-usrp/src/usrp_source_c.h
gnuradio/trunk/gr-usrp/src/usrp_source_s.h
gnuradio/trunk/gr-usrp2/src/usrp2_sink_16sc.h
gnuradio/trunk/gr-usrp2/src/usrp2_sink_32fc.h
gnuradio/trunk/gr-usrp2/src/usrp2_source_16sc.h
gnuradio/trunk/gr-usrp2/src/usrp2_source_32fc.h
gnuradio/trunk/usrp/host/lib/legacy/db_base.h
gnuradio/trunk/usrp/host/lib/legacy/usrp_basic.h
gnuradio/trunk/usrp/host/lib/legacy/usrp_standard.h
gnuradio/trunk/usrp2/host/include/usrp2/metadata.h
gnuradio/trunk/usrp2/host/include/usrp2/rx_nop_handler.h
gnuradio/trunk/usrp2/host/include/usrp2/rx_sample_handler.h
gnuradio/trunk/usrp2/host/include/usrp2/tune_result.h
gnuradio/trunk/usrp2/host/include/usrp2/usrp2.h
gnuradio/trunk/usrp2/host/lib/eth_buffer.cc
Log:
doc fixes! work-in-progress
Modified: gnuradio/trunk/docs/doxygen/other/group_defs.dox
===================================================================
--- gnuradio/trunk/docs/doxygen/other/group_defs.dox 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/docs/doxygen/other/group_defs.dox 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -1,67 +1,43 @@
/*!
- * \defgroup block Signal Processing Blocks
- * These are the signal processing blocks...
+ * \defgroup block GNU Radio C++ Signal Processing Blocks
+ * \brief All C++ blocks that can be used in GR graphs are listed here or in
+ * the subcategories below.
+ *
+ * Sorry, at this time the Python hierarchical blocks are not included
+ * in this index.
* @{
*/
-/*!
- * \defgroup source Signal Sources
- * signal sources docs...
- */
+/*! \defgroup container_blk Top Block and Hierarchical Block Base Classes
*/
+/*! \defgroup source_blk Signal Sources */
+/*! \defgroup sink_blk Signal Sinks */
+/*! \defgroup filter_blk Filters */
+/*! \defgroup math_blk Mathematics */
+/*! \defgroup modulation_blk Signal Modulation */
+/*! \defgroup demodulation_blk Signal Demodulation */
+/*! \defgroup coding_blk Information Coding and Decoding*/
+/*! \defgroup synch_blk Synchronization */
+/*! \defgroup eq_blk Equalization */
+/*! \defgroup converter_blk Type Conversions */
+/*! \defgroup level_blk Signal Level Control (AGC) */
+/*! \defgroup dft_blk Fourier Transform */
+/*! \defgroup wavelet_blk Wavelet Transform */
+/*! \defgroup misc_blk Miscellaneous Blocks */
+/*! \defgroup slicedice_blk Slicing and Dicing Streams */
+/*! \defgroup vocoder_blk Voice Encoders and Decoders */
-/*!
- * \defgroup sink Signal Sinks
- * docs for sinks...
+/*!
+ * \defgroup base_blk Base classes for GR Blocks
+ * \brief All C++ blocks are derived from these base classes
*/
-/*!
- * \defgroup filter Filters
- */
-/*!
- * \defgroup converter Type Conversions
- */
-
-/*!
- * \defgroup level Signal Level Control
- */
-
-/*!
- * \defgroup clock Signal Clock Synchronization
- */
-
-/*!
- * \defgroup dft Fourier Transformation
- */
-
-/*!
- * \defgroup synch Synchronization
- */
-
-/*!
- * \defgroup packet Packetization
- */
-
-/*!
- * \defgroup logic Logical
- */
-
/*! @} */
-/*! \defgroup filter_design Digital Filter Design */
-/*! \defgroup graphical Graphical Utilities */
-/*! \defgroup encdec Voice Encoders and Decoders */
-/*! \defgroup coding Information Coding and Decoding */
-/*! \defgroup modulation Signal Modulation */
-/*! \defgroup demodulation Signal Demodulation */
-/*! \defgroup flow Samples Flow Control */
-
-/*! \defgroup math Mathmatics */
-/*! \defgroup tools Tools */
-/*! \defgroup misc Miscellaneous */
+/*! \defgroup filter_design Digital Filter Design */
+/*! \defgroup misc Miscellaneous */
/*! \defgroup internal Implementation Details */
-/*! \defgroup base Misc Common Base Classes */
/*!
* \defgroup applications Applications
* These are some applications build using gnuradio...
@@ -90,6 +66,6 @@
/*! @} */
-/*! \defgroup usrp USRP */
-/*! \defgroup usrp2 USRP2 */
-/*! \defgroup hardware Hardware */
+/*! \defgroup usrp USRP */
+/*! \defgroup usrp2 USRP2 */
+/*! \defgroup hardware Misc Hardware Control */
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_adaptive_fir_ccf.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief Adaptive FIR filter with gr_complex input, gr_complex output and
float taps
- * \ingroup filter
+ * \ingroup filter_blk
*/
class gr_adaptive_fir_ccf : public gr_sync_decimator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_cma_equalizer_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_cma_equalizer_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_cma_equalizer_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Implements constant modulus adaptive filter on complex stream
- * \ingroup filter
+ * \ingroup eq_blk
*/
class gr_cma_equalizer_cc : public gr_adaptive_fir_ccf
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fft_filter_ccc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Fast FFT filter with gr_complex input, gr_complex output and
gr_complex taps
- * \ingroup filter
+ * \ingroup filter_blk
*/
class gr_fft_filter_ccc : public gr_sync_decimator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fft_filter_fff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fft_filter_fff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fft_filter_fff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Fast FFT filter with float input, float output and float taps
- * \ingroup filter
+ * \ingroup filter_blk
*/
class gr_fft_filter_fff : public gr_sync_decimator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_filter_delay_fc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_filter_delay_fc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_filter_delay_fc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -37,7 +37,7 @@
/*!
* \brief Filter-Delay Combination Block.
- * \ingroup filter
+ * \ingroup filter_blk
*
* The block takes one or two float stream and outputs a complex
* stream. If only one float stream is input, the real output is
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccc_simd.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -26,7 +26,7 @@
/*!
* \brief common base class for SIMD versions of gr_fir_ccc
- * \ingroup filter
+ * \ingroup filter_primitive
*
* This base class handles alignment issues common to SSE and 3DNOW
* subclasses.
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccf_simd.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief common base class for SIMD versions of gr_fir_ccf
- * \ingroup filter
+ * \ingroup filter_primitive
*
* This base class handles alignment issues common to SSE and 3DNOW
* subclasses.
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_ccf_x86.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief 3DNow! version of gr_fir_ccf
- * \ingroup filter
+ * \ingroup filter_primitive
*/
class gr_fir_ccf_3dnow : public gr_fir_ccf_simd
{
@@ -38,7 +38,7 @@
/*!
* \brief SSE version of gr_fir_ccf
- * \ingroup filter
+ * \ingroup filter_primitive
*/
class gr_fir_ccf_sse : public gr_fir_ccf_simd
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fcc_simd.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief common base class for SIMD versions of gr_fir_fcc
- * \ingroup filter
+ * \ingroup filter_primitive
*
* This base class handles alignment issues common to SSE and 3DNOW
* subclasses.
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fcc_x86.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief 3DNow! version of gr_fir_fcc
- * \ingroup filter
+ * \ingroup filter_primitive
*/
class gr_fir_fcc_3dnow : public gr_fir_fcc_simd
{
@@ -38,7 +38,7 @@
/*!
* \brief SSE version of gr_fir_fcc
- * \ingroup filter
+ * \ingroup filter_blk
*/
class gr_fir_fcc_sse : public gr_fir_fcc_simd
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fff_simd.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -26,7 +26,7 @@
/*!
* \brief common base class for SIMD versions of gr_fir_fff
- * \ingroup filter
+ * \ingroup filter_primitive
*
* This base class handles alignment issues common to SSE and 3DNOW
* subclasses.
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_filter_XXX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -38,7 +38,7 @@
/*!
* \brief FIR filter with @I_TYPE@ input, @O_TYPE@ output and @TAP_TYPE@ taps
- * \ingroup filter
+ * \ingroup filter_blk
*/
class @NAME@ : public gr_sync_decimator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_simd.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -26,7 +26,7 @@
/*!
* \brief common base class for SIMD versions of gr_fir_fsf
- * \ingroup filter
+ * \ingroup filter_primitive
*
* This base class handles alignment issues common to SSE and 3DNOW
* subclasses.
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief 3DNow! version of gr_fir_fsf
- * \ingroup filter
+ * \ingroup filter_blk
*/
class gr_fir_fsf_3dnow : public gr_fir_fsf_simd
{
@@ -38,7 +38,7 @@
/*!
* \brief SSE version of gr_fir_fsf
- * \ingroup filter
+ * \ingroup filter_blk
*/
class gr_fir_fsf_sse : public gr_fir_fsf_simd
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief common base class for SIMD versions of gr_fir_scc
- * \ingroup filter
+ * \ingroup filter_blk
*
* This base class handles alignment issues common to SSE and 3DNOW
* subclasses.
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fractional_interpolator_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief Interpolating mmse filter with gr_complex input, gr_complex output
- * \ingroup filter
+ * \ingroup filter_blk
*/
class gr_fractional_interpolator_cc : public gr_block
{
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fractional_interpolator_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief Interpolating mmse filter with float input, float output
- * \ingroup filter
+ * \ingroup filter_blk
*/
class gr_fractional_interpolator_ff : public gr_block
{
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t
===================================================================
---
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_freq_xlating_fir_filter_XXX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -49,7 +49,7 @@
/*!
* \brief FIR filter combined with frequency translation with @I_TYPE@ input,
@O_TYPE@ output and @TAP_TYPE@ taps
- * \ingroup filter
+ * \ingroup filter_blk
*
* This class efficiently combines a frequency translation
* (typically "down conversion") with a FIR filter (typically low-pass)
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_goertzel_fc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_goertzel_fc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_goertzel_fc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Goertzel single-bin DFT calculation.
- * \ingroup dft
+ * \ingroup dft_blk
*/
class gr_goertzel_fc : public gr_sync_decimator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_hilbert_fc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_hilbert_fc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_hilbert_fc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -38,7 +38,7 @@
/*!
* \brief Hilbert transformer.
- * \ingroup filter
+ * \ingroup filter_blk
*
* real output is input appropriately delayed.
* imaginary output is hilbert filtered (90 degree phase shift)
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_iir_filter_ffd.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief IIR filter with float input, float output and double taps
- * \ingroup filter
+ * \ingroup filter_blk
*
* This filter uses the Direct Form I implementation, where
* \p fftaps contains the feed-forward taps, and \p fbtaps the feedback ones.
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_interp_fir_filter_XXX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -38,7 +38,7 @@
/*!
* \brief Interpolating FIR filter with @I_TYPE@ input, @O_TYPE@ output and
@TAP_TYPE@ taps
- * \ingroup filter
+ * \ingroup filter_blk
*/
class @NAME@ : public gr_sync_interpolator
{
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t
===================================================================
---
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_rational_resampler_base_XXX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -42,7 +42,7 @@
/*!
* \brief Rational Resampling Polyphase FIR filter with @I_TYPE@ input,
@O_TYPE@ output and @TAP_TYPE@ taps
- * \ingroup filter
+ * \ingroup filter_blk
*/
class @NAME@ : public gr_block
{
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -36,7 +36,7 @@
/*!
* \brief single pole IIR filter with complex input, complex output
- * \ingroup filter
+ * \ingroup filter_blk
*
* The input and output satisfy a difference equation of the form
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_single_pole_iir_filter_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief single pole IIR filter with float input, float output
- * \ingroup filter
+ * \ingroup filter_blk
*
* The input and output satisfy a difference equation of the form
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gri_goertzel.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gri_goertzel.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gri_goertzel.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,9 +27,8 @@
/*!
* \brief Implements Goertzel single-bin DFT calculation
- * \ingroup dft
+ * \ingroup misc
*/
-
class gri_goertzel
{
public:
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -28,7 +28,7 @@
/*!
* \brief Compute intermediate samples between signal samples x(k*Ts)
- * \ingroup filter
+ * \ingroup filter_primitive
*
* This implements a Mininum Mean Squared Error interpolator with 8 taps.
* It is suitable for signals where the bandwidth of interest B = 1/(4*Ts)
Modified:
gnuradio/trunk/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gri_mmse_fir_interpolator_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -29,7 +29,7 @@
/*!
* \brief Compute intermediate samples between signal samples x(k*Ts)
- * \ingroup filter
+ * \ingroup filter_primitive
*
* This implements a Mininum Mean Squared Error interpolator with 8 taps.
* It is suitable for signals where the bandwidth of interest B = 1/(4*Ts)
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc2_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc2_cc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc2_cc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
float gain = 1.0, float max_gain = 0.0);
/*!
* \brief high performance Automatic Gain Control class
- * \ingroup level
+ * \ingroup level_blk
*
* For Power the absolute value of the complex number is used.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc2_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc2_ff.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc2_ff.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief high performance Automatic Gain Control class
*
- * \ingroup level
+ * \ingroup level_blk
* Power is approximated by absolute value
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc_cc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc_cc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
float gain = 1.0, float max_gain = 0.0);
/*!
* \brief high performance Automatic Gain Control class
- * \ingroup level
+ * \ingroup level_blk
*
* For Power the absolute value of the complex number is used.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc_ff.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_agc_ff.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief high performance Automatic Gain Control class
- * \ingroup level
+ * \ingroup level_blk
*
* Power is approximated by absolute value
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_bin_statistics_f.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_bin_statistics_f.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_bin_statistics_f.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -42,7 +42,7 @@
/*!
* \brief control scanning and record frequency domain statistics
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_bin_statistics_f : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_binary_slicer_fb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_binary_slicer_fb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_binary_slicer_fb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief slice float binary symbol outputting 1 bit output
- * \ingroup converter
+ * \ingroup converter_blk
*
* x < 0 --> 0
* x >= 0 --> 1
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_bytes_to_syms.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_bytes_to_syms.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_bytes_to_syms.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -31,7 +31,7 @@
/*!
* \brief Convert stream of bytes to stream of +/- 1 symbols
- * \ingroup converter
+ * \ingroup converter_blk
*
* input: stream of bytes; output: stream of float
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_char_to_float.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_char_to_float.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_char_to_float.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Convert stream of chars to a stream of float
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_char_to_float : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_check_counting_s.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_check_counting_s.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_check_counting_s.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief sink that checks if its input stream consists of a counting sequence.
* \param do_32bit expect an interleaved 32 bit counter in stead of 16 bit
counter (default false)
- * \ingroup sink
+ * \ingroup sink_blk
*
* This sink is typically used to test the USRP "Counting Mode" or "Counting
mode 32 bit".
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_check_lfsr_32k_s.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief sink that checks if its input stream consists of a lfsr_32k sequence.
- * \ingroup sink
+ * \ingroup sink_blk
*
* This sink is typically used along with gr_lfsr_32k_source_s to test
* the USRP using its digital loopback mode.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -39,7 +39,7 @@
/*!
* \brief Mueller and Müller (M&M) based clock recovery block with complex
input, complex output.
- * \ingroup clock
+ * \ingroup synch_blk
*
* This implements the Mueller and Müller (M&M) discrete-time error-tracking
synchronizer.
* The complex version here is based on:
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -39,7 +39,7 @@
/*!
* \brief Mueller and Müller (M&M) based clock recovery block with float
input, float output.
- * \ingroup clock
+ * \ingroup synch_blk
*
* This implements the Mueller and Müller (M&M) discrete-time error-tracking
synchronizer.
*
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h
===================================================================
---
gnuradio/trunk/gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h
2009-05-22 12:42:51 UTC (rev 11084)
+++
gnuradio/trunk/gnuradio-core/src/lib/general/gr_complex_to_interleaved_short.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Convert stream of complex to a stream of interleaved shorts
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_complex_to_interleaved_short : public gr_sync_interpolator
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_complex_to_xxx.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_complex_to_xxx.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_complex_to_xxx.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -49,7 +49,7 @@
/*!
* \brief convert a stream of gr_complex to 1 or 2 streams of float
- * \ingroup converter
+ * \ingroup converter_blk
* \param vlen vector len (default 1)
*/
class gr_complex_to_float : public gr_sync_block
@@ -67,7 +67,7 @@
/*!
* \brief complex in, real out (float)
- * \ingroup converter
+ * \ingroup converter_blk
* \param vlen vector len (default 1)
*/
class gr_complex_to_real : public gr_sync_block
@@ -85,7 +85,7 @@
/*!
* \brief complex in, imaginary out (float)
- * \ingroup converter
+ * \ingroup converter_blk
* \param vlen vector len (default 1)
*/
class gr_complex_to_imag : public gr_sync_block
@@ -103,7 +103,7 @@
/*!
* \brief complex in, magnitude out (float)
- * \ingroup converter
+ * \ingroup converter_blk
* \param vlen vector len (default 1)
*/
class gr_complex_to_mag : public gr_sync_block
@@ -121,7 +121,7 @@
/*!
* \brief complex in, magnitude squared out (float)
- * \ingroup converter
+ * \ingroup converter_blk
* \param vlen vector len (default 1)
*/
class gr_complex_to_mag_squared : public gr_sync_block
@@ -139,7 +139,7 @@
/*!
* \brief complex in, angle out (float)
- * \ingroup converter
+ * \ingroup converter_blk
* \param vlen vector len (default 1)
*/
class gr_complex_to_arg : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_conjugate_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_conjugate_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_conjugate_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = complex conjugate of input
- * \ingroup math
+ * \ingroup math_blk
*/
class gr_conjugate_cc : public gr_sync_block
{
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_constellation_decoder_cb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief Constellation Decoder
- * \ingroup coding
+ * \ingroup coding_blk
*
*/
class gr_constellation_decoder_cb : public gr_sync_block
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -38,7 +38,7 @@
/*!
* \brief Examine input for specified access code, one bit at a time.
- * \ingroup synch
+ * \ingroup synch_blk
*
* input: stream of bits, 1 bit per input byte (data in LSB)
* output: stream of bits, 2 bits per output byte (data in LSB, flag in next
higher bit)
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -30,7 +30,7 @@
/*! \brief A Costas loop carrier recovery module.
- * \ingroup clock
+ * \ingroup synch_blk
*
* The Costas loop locks to the center frequency of a signal and
* downconverts it to baseband. The second (order=2) order loop is
@@ -49,8 +49,8 @@
*
* \param alpha the loop gain used for phase adjustment
* \param beta the loop gain for frequency adjustments
- * \param max_freq the maximum frequency deviation (normalized frequency) the
loop can handle
- * \param min_freq the minimum frequency deviation (normalized frequency) the
loop can handle
+ * \param max_freq the maximum frequency deviation (radians/sample) the loop
can handle
+ * \param min_freq the minimum frequency deviation (radians/sample) the loop
can handle
* \param order the loop order, either 2 or 4
*/
class gr_costas_loop_cc;
@@ -66,7 +66,7 @@
/*!
* \brief Carrier tracking PLL for QPSK
- * \ingroup clock
+ * \ingroup synch_blk
* input: complex; output: complex
* <br>The Costas loop can have two output streams:
* stream 1 is the baseband I and Q;
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_cpfsk_bc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_cpfsk_bc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_cpfsk_bc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -31,7 +31,7 @@
/*!
* \brief Perform continuous phase 2-level frequency shift keying modulation
* on an input stream of unpacked bits.
- * \ingroup modulation
+ * \ingroup modulation_blk
*
* \param k modulation index
* \param ampl output amplitude
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ctcss_squelch_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief gate or zero output if ctcss tone not present
- * \ingroup level
+ * \ingroup level_blk
*/
class gr_ctcss_squelch_ff : public gr_squelch_base_ff
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -37,7 +37,7 @@
/*!
* \brief Decision directed M-PSK synchronous demod
- * \ingroup clock
+ * \ingroup synch_blk
* This block performs joint carrier tracking and symbol timing recovery.
*
* input: complex baseband; output: properly timed complex samples ready for
slicing.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_deinterleave.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_deinterleave.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_deinterleave.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief deinterleave a single input into N outputs
- * \ingroup misc
+ * \ingroup slicedice_blk
*/
class gr_deinterleave : public gr_sync_decimator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_delay.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_delay.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_delay.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief delay the input by a certain number of samples
- * \ingroup misc
+ * \ingroup misc_blk
*/
class gr_delay : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_diff_decoder_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_diff_decoder_bb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_diff_decoder_bb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief y[0] = (x[0] - x[-1]) % M
- * \ingroup coding
+ * \ingroup coding_blk
*
* Differential decoder
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_diff_encoder_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_diff_encoder_bb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_diff_encoder_bb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief y[0] = (x[0] + y[-1]) % M
- * \ingroup coding
+ * \ingroup coding_blk
*
* Differential encoder
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_dpll_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_dpll_bb.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_dpll_bb.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Detect the peak of a signal
- * \ingroup level
+ * \ingroup level_blk
*
* If a peak is detected, this block outputs a 1,
* or it outputs 0's.
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_fake_channel_coder_pp.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief pad packet with alternating 1,0 pattern.
- * \ingroup coding
+ * \ingroup coding_blk
*
* input: stream of byte vectors; output: stream of byte vectors
*/
@@ -65,7 +65,7 @@
/*!
* \brief remove fake padding from packet
- * \ingroup coding
+ * \ingroup coding_blk
*
* input: stream of byte vectors; output: stream of byte vectors
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_feedforward_agc_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Non-causal AGC which computes required gain based on max absolute
value over nsamples
- * \ingroup level
+ * \ingroup level_blk
*/
class gr_feedforward_agc_cc : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vcc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vcc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vcc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Compute forward or reverse FFT. complex vector in / complex vector
out.
- * \ingroup dft
+ * \ingroup dft_blk
*
* Abstract base class
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vcc_fftw.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Compute forward or reverse FFT. complex vector in / complex vector
out.
- * \ingroup dft
+ * \ingroup dft_blk
*
* Concrete class that uses FFTW.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vfc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vfc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_fft_vfc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief Compute forward FFT. float vector in / complex vector out.
- * \ingroup dft
+ * \ingroup dft_blk
*/
class gr_fft_vfc : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_char.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_char.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_char.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Convert stream of float to a stream of char
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_float_to_char : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_complex.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_complex.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_complex.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Convert 1 or 2 streams of float to a stream of gr_complex
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_float_to_complex : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_short.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_short.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_short.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Convert stream of float to a stream of short
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_float_to_short : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_uchar.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_uchar.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_float_to_uchar.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Convert stream of float to a stream of unsigned char
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_float_to_uchar : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_framer_sink_1.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_framer_sink_1.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_framer_sink_1.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Given a stream of bits and access_code flags, assemble packets.
- * \ingroup sink
+ * \ingroup sink_blk
*
* input: stream of bytes from gr_correlate_access_code_bb
* output: none. Pushes assembled packet into target queue
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_frequency_modulator_fc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Frequency modulator block
- * \ingroup modulation
+ * \ingroup modulation_blk
*
* float input; complex baseband output
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_fxpt.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_fxpt.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_fxpt.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -26,7 +26,7 @@
/*!
* \brief fixed point sine and cosine and friends.
- * \ingroup math
+ * \ingroup misc
*
* fixed pt radians
* --------- --------
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_glfsr_source_b.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_glfsr_source_b.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_glfsr_source_b.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Galois LFSR pseudo-random source
- * \ingroup source
+ * \ingroup source_blk
*/
class gr_glfsr_source_b : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_glfsr_source_f.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_glfsr_source_f.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_glfsr_source_f.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0
- * \ingroup source
+ * \ingroup source_blk
*/
class gr_glfsr_source_f : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_head.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_head.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_head.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -28,7 +28,7 @@
/*!
* \brief copies the first N items to the output then signals done
- * \ingroup flow
+ * \ingroup slicedice_blk
*
* Useful for building test cases
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_interleave.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_interleave.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_interleave.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief interleave N inputs to a single output
- * \ingroup misc
+ * \ingroup slicedice_blk
*/
class gr_interleave : public gr_sync_interpolator
{
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h
===================================================================
---
gnuradio/trunk/gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h
2009-05-22 12:42:51 UTC (rev 11084)
+++
gnuradio/trunk/gnuradio-core/src/lib/general/gr_interleaved_short_to_complex.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Convert stream of interleaved shorts to a stream of complex
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_interleaved_short_to_complex : public gr_sync_decimator
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_iqcomp_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_iqcomp_cc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_iqcomp_cc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief
- * \ingroup
+ * \ingroup misc_blk
*/
class gr_iqcomp_cc : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_keep_one_in_n.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_keep_one_in_n.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_keep_one_in_n.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief decimate a stream, keeping one item out of every n.
- * \ingroup misc
+ * \ingroup slicedice_blk
*/
class gr_keep_one_in_n : public gr_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_kludge_copy.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_kludge_copy.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_kludge_copy.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief output[i] = input[i]
- * \ingroup misc
+ * \ingroup misc_blk
*
* This is a short term kludge to work around a problem with the hierarchical
block impl.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_lfsr_32k_source_s.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief LFSR pseudo-random source with period of 2^15 bits (2^11 shorts)
- * \ingroup source
+ * \ingroup source_blk
*
* This source is typically used along with gr_check_lfsr_32k_s to test
* the USRP using its digital loopback mode.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_lms_dfe_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Least-Mean-Square Decision Feedback Equalizer (complex in/out)
- * \ingroup misc
+ * \ingroup eq_blk
*/
class gr_lms_dfe_cc : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_lms_dfe_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_lms_dfe_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_lms_dfe_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Least-Mean-Square Decision Feedback Equalizer (float in/out)
- * \ingroup misc
+ * \ingroup eq_blk
*/
class gr_lms_dfe_ff : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_map_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_map_bb.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_map_bb.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -31,7 +31,7 @@
/*!
* \brief output[i] = map[input[i]]
- * \ingroup misc
+ * \ingroup coding_blk
*/
class gr_map_bb : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_math.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_math.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_math.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -50,7 +50,7 @@
/*!
* \brief Fast arc tangent using table lookup and linear interpolation
- * \ingroup math
+ * \ingroup misc
*
* \param y component of input vector
* \param x component of input vector
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -43,7 +43,7 @@
/*!
* \brief This block takes care of receiving M-PSK modulated signals through
phase, frequency, and symbol
* synchronization.
- * \ingroup synch
+ * \ingroup synch_blk
*
* This block takes care of receiving M-PSK modulated signals through phase,
frequency, and symbol
* synchronization. It performs carrier frequency and phase locking as well as
symbol timing recovery.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_nlog10_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_nlog10_ff.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_nlog10_ff.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -31,7 +31,7 @@
/*!
* \brief output = n*log10(input) + k
- * \ingroup math
+ * \ingroup math_blk
*/
class gr_nlog10_ff : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_nop.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_nop.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_nop.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -28,7 +28,7 @@
/*!
* \brief Does nothing. Used for testing only.
- * \ingroup misc
+ * \ingroup misc_blk
*/
class gr_nop : public gr_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_null_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_null_sink.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_null_sink.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -28,7 +28,7 @@
/*!
* \brief Bit bucket
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_null_sink : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_null_source.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_null_source.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_null_source.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief A source of zeros.
- * \ingroup source
+ * \ingroup source_blk
*/
class gr_null_source : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -37,7 +37,7 @@
/*!
* \brief take a vector of complex constellation points in from an FFT
* and demodulate to a stream of bits. Simple BPSK version.
- * \ingroup demodulation
+ * \ingroup demodulation_blk
*/
class gr_ofdm_bpsk_demapper : public gr_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -36,7 +36,7 @@
/*!
* \brief adds a cyclic prefix vector to an input size long ofdm
* symbol(vector) and converts vector to a stream output_size long.
- * \ingroup synch
+ * \ingroup synch_blk
*/
class gr_ofdm_cyclic_prefixer : public gr_sync_interpolator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -36,7 +36,7 @@
* \brief take a stream of vectors in from an FFT and demodulate to a stream of
* bits. Abstract class must be subclassed with specific mapping.
*
- * \ingroup demodulation
+ * \ingroup demodulation_blk
*/
class gr_ofdm_demapper_vcb : public gr_sync_decimator
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -39,7 +39,7 @@
/*!
* \brief take a vector of complex constellation points in from an FFT
* and performs a correlation and equalization.
- * \ingroup demodulation
+ * \ingroup demodulation_blk
*
* This block takes the output of an FFT of a received OFDM symbol and finds
the
* start of a frame based on two known symbols. It also looks at the
surrounding
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -38,7 +38,7 @@
/*!
* \brief Takes an OFDM symbol in, demaps it into bits of 0's and 1's, packs
* them into packets, and sends to to a message queue sink.
- * \ingroup sink
+ * \ingroup sink_blk
* NOTE: The mod input parameter simply chooses a pre-defined demapper/slicer.
Eventually,
* we want to be able to pass in a reference to an object to do the demapping
and slicing
* for a given modulation type.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief insert "pre-modulated" preamble symbols before each payload.
- * \ingroup synch
+ * \ingroup synch_blk
*
* <pre>
* input 1: stream of vectors of gr_complex [fft_length]
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -38,7 +38,7 @@
* \brief take a stream of bytes in and map to a vector of complex
* constellation points suitable for IFFT input to be used in an ofdm
* modulator. Abstract class must be subclassed with specific mapping.
- * \ingroup modulation
+ * \ingroup modulation_blk
*
*/
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pa_2x2_phase_combiner.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pa_2x2_phase_combiner.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pa_2x2_phase_combiner.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -31,7 +31,7 @@
/*!
* \brief pa_2x2 phase combiner
- * \ingroup misc
+ * \ingroup misc_blk
*
* Anntenas are arranged like this:
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_packet_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_packet_sink.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_packet_sink.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -36,7 +36,7 @@
);
/*!
* \brief process received bits looking for packet sync, header, and process
bits into packet
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_packet_sink : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_peak_detector2_fb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_peak_detector2_fb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_peak_detector2_fb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Detect the peak of a signal
- * \ingroup level
+ * \ingroup level_blk
*
* If a peak is detected, this block outputs a 1,
* or it outputs 0's. A separate debug output may be connected, to
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_phase_modulator_fc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_phase_modulator_fc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_phase_modulator_fc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Phase modulator block
- * \ingroup modulation
+ * \ingroup modulation_blk
* output=complex(cos(in*sensitivity),sin(in*sensitivity))
*/
class gr_phase_modulator_fc : public gr_sync_block
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Implements a PLL which locks to the input frequency and outputs the
* input signal mixed with that carrier.
- * \ingroup clock
+ * \ingroup synch_blk
*
* input: stream of complex; output: stream of complex
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Implements a PLL which locks to the input frequency and outputs
* an estimate of that frequency. Useful for FM Demod.
- * \ingroup clock
+ * \ingroup synch_blk
*
* input: stream of complex; output: stream of floats
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
float max_freq, float min_freq);
/*!
* \brief Implements a PLL which locks to the input frequency and outputs a
carrier
- * \ingroup clock
+ * \ingroup synch_blk
*
* input: stream of complex; output: stream of complex
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief PN code sequential search correlator
*
- * \ingroup synch
+ * \ingroup synch_blk
* Receives complex baseband signal, outputs complex correlation against
* reference PN code, one sample per PN code period
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_c.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief compute avg magnitude squared.
- * \ingroup sink
+ * \ingroup sink_blk
*
* input: gr_complex
*
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_cf.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief compute avg magnitude squared.
- * \ingroup sink
+ * \ingroup sink_blk
*
* input: gr_complex
* output: gr_float
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_avg_mag_sqrd_f.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief compute avg magnitude squared.
- * \ingroup sink
+ * \ingroup sink_blk
*
* input: float
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_mpsk_snr_c.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_mpsk_snr_c.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_mpsk_snr_c.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -37,7 +37,7 @@
* This technique assumes an AWGN channel.
*
* \param alpha Mean and variance smoothing filter constant
- * \ingroup sink
+ * \ingroup sink_blk
*
* Compute the running average of the signal mean and noise variance.
* The estimated signal mean, noise variance, and SNR are available
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_signal_f.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_signal_f.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_probe_signal_f.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Sink that allows a sample to be grabbed from Python.
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_probe_signal_f : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pwr_squelch_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief gate or zero output when input power below threshold
- * \ingroup level
+ * \ingroup level_blk
*/
class gr_pwr_squelch_cc : public gr_squelch_base_cc
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pwr_squelch_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief gate or zero output when input power below threshold
- * \ingroup level
+ * \ingroup level_blk
*/
class gr_pwr_squelch_ff : public gr_squelch_base_ff
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_quadrature_demod_cf.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -31,7 +31,7 @@
/*!
* \brief quadrature demodulator: complex in, float out
- * \ingroup demodulation
+ * \ingroup demodulation_blk
*
* This can be used to demod FM, FSK, GMSK, etc.
* The input is complex baseband.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_random.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_random.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_random.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief pseudo random number generator
- * \ingroup math
+ * \ingroup math_blk
*/
class gr_random {
protected:
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_regenerate_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_regenerate_bb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_regenerate_bb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Detect the peak of a signal and repeat every period samples
- * \ingroup level
+ * \ingroup level_blk
*
* If a peak is detected, this block outputs a 1 repeated every period samples
* until reset by detection of another 1 on the input or stopped after
max_regen
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_repeat.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_repeat.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_repeat.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Repeat a sample 'interp' times in output stream
- * \ingroup converter
+ * \ingroup misc_blk
*/
class gr_repeat : public gr_sync_interpolator
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_rms_cf.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_rms_cf.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_rms_cf.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief RMS average power
- * \ingroup math
+ * \ingroup math_blk
*/
class gr_rms_cf : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_rms_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_rms_ff.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_rms_ff.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief RMS average power
- * \ingroup math
+ * \ingroup math_blk
*/
class gr_rms_ff : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_scrambler_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_scrambler_bb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_scrambler_bb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -39,7 +39,7 @@
* \param seed Initial shift register contents
* \param len Shift register length
*
- * \ingroup misc
+ * \ingroup coding_blk
*/
class gr_scrambler_bb : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_short_to_float.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_short_to_float.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_short_to_float.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Convert stream of short to a stream of float
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_short_to_float : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_correlator.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_correlator.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_correlator.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief inverse of gr_simple_framer (more or less)
- * \ingroup synch
+ * \ingroup synch_blk
*/
class gr_simple_correlator : public gr_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief add sync field, seq number and command field to payload
- * \ingroup synch
+ * \ingroup synch_blk
*/
class gr_simple_framer : public gr_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -28,7 +28,7 @@
* the "mseq" matlab/octave code downloaded from:
*
http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=990&objectType=file
*
- * \ingroup synch
+ * \ingroup synch_blk
* 31-bit m-sequence:
* 0110100100001010111011000111110
* 0x690AEC76 (padded on right with a zero)
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_squelch_cc.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief simple squelch block based on average signal power and threshold in
dB.
- * \ingroup level
+ * \ingroup level_blk
*/
class gr_simple_squelch_cc : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_skiphead.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_skiphead.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_skiphead.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief skips the first N items, from then on copies items to the output
- * \ingroup flow
+ * \ingroup slicedice_blk
*
* Useful for building test cases and sources which have metadata or junk at
the start
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_mux.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_mux.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_mux.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -30,7 +30,7 @@
/*!
* \brief Creates a stream muxing block to multiplex many streams into
* one with a specified format.
- * \ingroup converter
+ * \ingroup converter_blk
*
* \param itemsize the item size of the stream
* \param length a vector (list/tuple) specifying the number of
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_to_streams.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_to_streams.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_to_streams.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief convert a stream of items into a N streams of items
- * \ingroup converter
+ * \ingroup slicedice_blk
*
* Converts a stream of N items into N streams of 1 item.
* Repeat ad infinitum.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_to_vector.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_to_vector.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_stream_to_vector.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief convert a stream of items into a stream of blocks containing
nitems_per_block
- * \ingroup converter
+ * \ingroup slicedice_blk
*/
class gr_stream_to_vector : public gr_sync_decimator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_streams_to_stream.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_streams_to_stream.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_streams_to_stream.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Convert N streams of 1 item into a 1 stream of N items
- * \ingroup converter
+ * \ingroup slicedice_blk
*
* Convert N streams of 1 item into 1 stream of N items.
* Repeat ad infinitum.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_streams_to_vector.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_streams_to_vector.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_streams_to_vector.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief convert N streams of items to 1 stream of vector length N
- * \ingroup converter
+ * \ingroup slicedice_blk
*/
class gr_streams_to_vector : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_stretch_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_stretch_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_stretch_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -29,7 +29,7 @@
* \brief adjust y-range of an input vector by mapping to range
* (max-of-input, stipulated-min). Primarily for spectral signature
* matching by normalizing spectrum dynamic ranges.
- * \ingroup misc
+ * \ingroup misc_blk
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_test.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_test.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_test.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -49,12 +49,7 @@
* factor and/or large output_multiple.
* The runtime system should detect this and create large enough buffers
* all through the signal chain.
- *
*/
-
-
-
-
class gr_test : public gr_block {
public:
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_threshold_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_threshold_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_threshold_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Please fix my documentation
- * \ingroup misc
+ * \ingroup misc_blk
*/
class gr_threshold_ff : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_throttle.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_throttle.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_throttle.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -35,9 +35,14 @@
/*!
* \brief throttle flow of samples such that the average rate does not exceed
samples_per_sec.
- * \ingroup flow
+ * \ingroup misc_blk
*
* input: one stream of itemsize; output: one stream of itemsize
+ *
+ * N.B. this should only be used in GUI apps where there is no other
+ * rate limiting block. It is not intended nor effective at precisely
+ * controlling the rate of samples. That should be controlled by a
+ * source or sink tied to sample clock. E.g., a USRP or audio card.
*/
class gr_throttle : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_uchar_to_float.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_uchar_to_float.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_uchar_to_float.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Convert stream of unsigned chars to a stream of float
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_uchar_to_float : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_unpack_k_bits_bb.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Converts a byte with k relevent bits to k output bytes with 1 bit in
the LSB.
- * \ingroup converter
+ * \ingroup converter_blk
*/
class gr_unpack_k_bits_bb : public gr_sync_interpolator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_vco_f.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_vco_f.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_vco_f.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -41,6 +41,7 @@
/*!
* \brief VCO - Voltage controlled oscillator
+ * \ingroup modulator_blk
*
* input: float stream of control voltages; output: float oscillator output
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_vector_to_stream.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_vector_to_stream.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_vector_to_stream.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief convert a stream of blocks of nitems_per_block items into a stream
of items
- * \ingroup converter
+ * \ingroup slicedice_blk
*/
class gr_vector_to_stream : public gr_sync_interpolator
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_vector_to_streams.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_vector_to_streams.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_vector_to_streams.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Convert 1 stream of vectors of length N to N streams of items
- * \ingroup converter
+ * \ingroup slicedice_blk
*/
class gr_vector_to_streams : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_wavelet_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_wavelet_ff.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_wavelet_ff.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -38,7 +38,7 @@
/*!
* \brief compute wavelet transform using gsl routines
- * \ingroup math
+ * \ingroup wavelet_blk
*/
class gr_wavelet_ff : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_wvps_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_wvps_ff.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_wvps_ff.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief computes the Wavelet Power Spectrum from a set of wavelet
coefficients
- * \ingroup misc
+ * \ingroup wavelet_blk
*/
class gr_wvps_ff : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc2_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc2_cc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc2_cc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,11 +27,9 @@
/*!
* \brief high performance Automatic Gain Control class
- * \ingroup level
*
* For Power the absolute value of the complex number is used.
*/
-
class gri_agc2_cc {
public:
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc2_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc2_ff.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc2_ff.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,7 +27,6 @@
/*!
* \brief high performance Automatic Gain Control class with attack and decay
rate
- * \ingroup level
*
* Power is approximated by absolute value
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc_cc.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc_cc.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,7 +27,6 @@
/*!
* \brief high performance Automatic Gain Control class
- * \ingroup level
*
* For Power the absolute value of the complex number is used.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc_ff.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_agc_ff.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,11 +27,9 @@
/*!
* \brief high performance Automatic Gain Control class
- * \ingroup level
*
* Power is approximated by absolute value
*/
-
class gri_agc_ff {
public:
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_fft.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_fft.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_fft.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -44,7 +44,7 @@
/*!
* \brief FFT: complex in, complex out
- * \ingroup dft
+ * \ingroup misc
*/
class gri_fft_complex {
int d_fft_size;
@@ -75,7 +75,7 @@
/*!
* \brief FFT: real in, complex out
- * \ingroup dft
+ * \ingroup dft_blk
*/
class gri_fft_real_fwd {
int d_fft_size;
@@ -106,7 +106,7 @@
/*!
* \brief FFT: complex in, float out
- * \ingroup dft
+ * \ingroup dft_blk
*/
class gri_fft_real_rev {
int d_fft_size;
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_glfsr.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_glfsr.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_glfsr.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -25,7 +25,7 @@
/*!
* \brief Galois Linear Feedback Shift Register using specified polynomial mask
- * \ingroup math
+ * \ingroup misc
*
* Generates a maximal length pseudo-random sequence of length 2^degree-1
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -28,7 +28,7 @@
/*!
* \brief Fibonacci Linear Feedback Shift Register using specified polynomial
mask
- * \ingroup math
+ * \ingroup misc
*
* Generates a maximal length pseudo-random sequence of length 2^degree-1
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr_15_1_0.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr_15_1_0.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr_15_1_0.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -25,7 +25,7 @@
/*!
* \brief Linear Feedback Shift Register using primitive polynomial x^15 + x +
1
- * \ingroup math
+ * \ingroup misc
*
* Generates a maximal length pseudo-random sequence of length 2^15 - 1 bits.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr_32k.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr_32k.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_lfsr_32k.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief generate pseudo-random sequence of length 32768 bits.
- * \ingroup math
+ * \ingroup misc
*
* This is based on gri_lfsr_15_1_0 with an extra 0 added at the end
* of the sequence.
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_XX.h.t 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_XX.h.t 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = sum (input_0, input_1, ...)
- * \ingroup math
+ * \ingroup math_blk
*
* Add across all input streams.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_const_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_const_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_const_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = input + constant
- * \ingroup math
+ * \ingroup math_blk
*/
class @NAME@ : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_const_vXX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_const_vXX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_add_const_vXX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output vector = input vector + constant vector
- * \ingroup math
+ * \ingroup math_blk
*/
class @NAME@ : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_and_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_and_XX.h.t 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_and_XX.h.t 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = input_0 & input_1 & , ... & input_N)
- * \ingroup math
+ * \ingroup math_blk
*
* bitwise boolean and across all input streams.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_and_const_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_and_const_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_and_const_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output_N = input_N & value
- * \ingroup math
+ * \ingroup math_blk
*
* bitwise boolean and of const to the data stream.
*/
Modified:
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_chunks_to_symbols_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_chunks_to_symbols_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_chunks_to_symbols_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Map a stream of symbol indexes (unpacked bytes or shorts) to stream
of float or complex onstellation points.in \p D dimensions (\p D = 1 by default)
- * \ingroup converter
+ * \ingroup converter_blk
*
* input: stream of @I_TYPE@; output: stream of @O_TYPE@
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_divide_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_divide_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_divide_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = input_0 / input_1 / input_x ...)
- * \ingroup math
+ * \ingroup math_blk
*
* Divide across all input streams.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_integrate_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_integrate_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_integrate_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief output = sum(input[0]...input[n])
- * \ingroup math
+ * \ingroup math_blk
*
* Integrate successive samples in input stream and decimate
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_moving_average_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -35,7 +35,7 @@
/*!
* \brief output is the moving sum of the last N samples, scaled by the scale
factor
- * \ingroup filter
+ * \ingroup filter_blk
*
* max_iter limits how long we go without flushing the accumulator
* This is necessary to avoid numerical instability for float and complex.
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = prod (input_0, input_1, ...)
- * \ingroup math
+ * \ingroup math_blk
*
* Multiply across all input streams.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_const_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_const_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_const_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = input * constant
- * \ingroup math
+ * \ingroup math_blk
*/
class @NAME@ : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_const_vXX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_const_vXX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_multiply_const_vXX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output vector = input vector * constant vector (element-wise)
- * \ingroup math
+ * \ingroup math_blk
*/
class @NAME@ : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_mute_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_mute_XX.h.t 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_mute_XX.h.t 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = input or zero if muted.
- * \ingroup level
+ * \ingroup level_blk
*/
class @NAME@ : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_noise_source_X.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_noise_source_X.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_noise_source_X.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -38,7 +38,7 @@
/*!
* \brief random number source
- * \ingroup source
+ * \ingroup source_blk
*/
class @NAME@ : public gr_sync_block {
friend @address@hidden
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_not_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_not_XX.h.t 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_not_XX.h.t 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = ~input_0
- * \ingroup math
+ * \ingroup math_blk
*
* bitwise boolean not across input stream.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_or_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_or_XX.h.t 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_or_XX.h.t 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = input_0 | input_1 | , ... | input_N)
- * \ingroup math
+ * \ingroup math_blk
*
* bitwise boolean or across all input streams.
*/
Modified:
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_packed_to_unpacked_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_packed_to_unpacked_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_packed_to_unpacked_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -36,7 +36,7 @@
/*!
* \brief Convert a stream of packed bytes or shorts to stream of unpacked
bytes or shorts.
- * \ingroup converter
+ * \ingroup converter_blk
*
* input: stream of @I_TYPE@; output: stream of @O_TYPE@
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_peak_detector_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_peak_detector_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_peak_detector_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -37,7 +37,7 @@
/*!
* \brief Detect the peak of a signal
- * \ingroup level
+ * \ingroup level_blk
*
* If a peak is detected, this block outputs a 1,
* or it outputs 0's.
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sample_and_hold_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief sample and hold circuit
- * \ingroup level
+ * \ingroup level_blk
*
* Samples the data stream (input stream 0) and holds the value
* if the control signal is 1 (intput stream 1).
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sig_source_X.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sig_source_X.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sig_source_X.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief signal generator with @TYPE@ output.
- * \ingroup source
+ * \ingroup source_blk
*/
class @NAME@ : public gr_sync_block {
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_sub_XX.h.t 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = input_0 - input_1 - ...)
- * \ingroup math
+ * \ingroup math_blk
*
* Subtract across all input streams.
*/
Modified:
gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_unpacked_to_packed_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_unpacked_to_packed_XX.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_unpacked_to_packed_XX.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -36,7 +36,7 @@
/*!
* \brief Convert a stream of unpacked bytes or shorts into a stream of packed
bytes or shorts.
- * \ingroup converter
+ * \ingroup converter_blk
*
* input: stream of @I_TYPE@; output: stream of @O_TYPE@
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_vector_sink_X.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_vector_sink_X.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_vector_sink_X.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -36,7 +36,7 @@
/*!
* \brief @TYPE@ sink that writes to a vector
- * \ingroup sink
+ * \ingroup sink_blk
*/
class @NAME@ : public gr_sync_block {
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_vector_source_X.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_vector_source_X.h.t
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_vector_source_X.h.t
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief source of @TYPE@'s that gets its data from a vector
- * \ingroup source
+ * \ingroup source_blk
*/
class @NAME@ : public gr_sync_block {
Modified: gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_xor_XX.h.t
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_xor_XX.h.t 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/gengen/gr_xor_XX.h.t 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief output = input_0 ^ input_1 ^ , ... ^ input_N)
- * \ingroup math
+ * \ingroup math_blk
*
* bitwise boolean xor across all input streams.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_descriptor_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_descriptor_sink.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_descriptor_sink.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -32,7 +32,7 @@
/*!
* \brief Write stream to file descriptor.
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_file_descriptor_sink : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_descriptor_source.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_descriptor_source.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_descriptor_source.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Read stream from file descriptor.
- * \ingroup source
+ * \ingroup source_blk
*/
class gr_file_descriptor_source : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_sink.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_sink.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Write stream to file.
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_file_sink : public gr_sync_block, public gr_file_sink_base
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_source.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_source.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_file_source.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -33,7 +33,7 @@
/*!
* \brief Read stream from file
- * \ingroup source
+ * \ingroup source_blk
*/
class gr_file_source : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_histo_sink_f.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_histo_sink_f.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_histo_sink_f.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Histogram module.
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_histo_sink_f : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_message_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_message_sink.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_message_sink.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -36,7 +36,7 @@
/*!
* \brief Gather received items into messages and insert into msgq
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_message_sink : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_message_source.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_message_source.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_message_source.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Turn received messages into a stream
- * \ingroup source
+ * \ingroup source_blk
*/
class gr_message_source : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_oscope_sink_f.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_oscope_sink_f.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_oscope_sink_f.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -34,7 +34,7 @@
/*!
* \brief Building block for python oscilloscope module.
- * \ingroup sink
+ * \ingroup sink_blk
*
* Accepts multiple float streams.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_oscope_sink_x.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_oscope_sink_x.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_oscope_sink_x.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -30,7 +30,7 @@
/*!
* \brief Abstract class for python oscilloscope module.
- * \ingroup sink
+ * \ingroup sink_blk
*
* Don't instantiate this. Use gr_oscope_sink_f or gr_oscope_sink_c instead.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_udp_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_udp_sink.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_udp_sink.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -47,7 +47,7 @@
/*!
* \brief Write stream to an UDP socket.
- * \ingroup sink
+ * \ingroup sink_blk
*
* \param itemsize The size (in bytes) of the item datatype
* \param src The source address as either the host name or the
'numbers-and-dots'
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_udp_source.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_udp_source.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_udp_source.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -44,7 +44,7 @@
/*!
* \brief Read stream from an UDP socket.
- * \ingroup sink
+ * \ingroup source_blk
*
* \param itemsize The size (in bytes) of the item datatype
* \param src The source address as either the host name or the
'numbers-and-dots'
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_wavfile_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_wavfile_sink.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_wavfile_sink.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -48,7 +48,7 @@
* Values are within [-1;1].
* Check gr_make_wavfile_source() for extra info.
*
- * \ingroup sink
+ * \ingroup sink_blk
*/
class gr_wavfile_sink : public gr_sync_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/io/gr_wavfile_source.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/io/gr_wavfile_source.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/io/gr_wavfile_source.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -37,7 +37,7 @@
* Unless otherwise called, values are within [-1;1].
* Check gr_make_wavfile_source() for extra info.
*
- * \ingroup source
+ * \ingroup source_blk
*/
class gr_wavfile_source : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_basic_block.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_basic_block.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_basic_block.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -30,7 +30,7 @@
/*!
* \brief The abstract base class for all signal processing blocks.
- * \ingroup base
+ * \ingroup internal
*
* Basic blocks are the bare abstraction of an entity that has a name
* and a set of inputs and outputs. These are never instantiated
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_block.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_block.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_block.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief The abstract base class for all 'terminal' processing blocks.
- * \ingroup base
+ * \ingroup base_blk
*
* A signal processing flow is constructed by creating a tree of
* hierarchical blocks, which at any level may also contain terminal nodes
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_flat_flowgraph.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -33,8 +33,7 @@
/*!
*\brief Class specializing gr_flat_flowgraph that has all nodes
* as gr_blocks, with no hierarchy
- * \ingroup base
- *
+ * \ingroup internal
*/
class gr_flat_flowgraph : public gr_flowgraph
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_flowgraph.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_flowgraph.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_flowgraph.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,9 +27,8 @@
#include <iostream>
/*!
- *\brief Class representing a specific input or output graph endpoint
+ * \brief Class representing a specific input or output graph endpoint
* \ingroup internal
- *
*/
class gr_endpoint
{
@@ -85,8 +84,8 @@
gr_flowgraph_sptr gr_make_flowgraph();
/*!
- *\brief Class representing a directed, acyclic graph of basic blocks
- *
+ * \brief Class representing a directed, acyclic graph of basic blocks
+ * \ingroup internal
*/
class gr_flowgraph
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -36,7 +36,8 @@
/*!
* \brief gr_hier_block2 - Hierarchical container class for gr_block's
- * \ingroup internal
+ * \ingroup container_blk
+ * \ingroup base_blk
*
*/
class gr_hier_block2 : public gr_basic_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2_detail.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2_detail.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2_detail.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -26,6 +26,9 @@
#include <gr_flat_flowgraph.h>
#include <boost/utility.hpp>
+/*!
+ * \ingroup internal
+ */
class gr_hier_block2_detail : boost::noncopyable
{
public:
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_io_signature.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_io_signature.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_io_signature.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -85,6 +85,7 @@
/*!
* \brief i/o signature for input and output ports.
+ * \brief misc
*/
class gr_io_signature {
int d_min_streams;
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_block.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_block.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_block.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief synchronous 1:1 input to output with history
- * \ingroup internal
+ * \ingroup base_blk
*
* Override work to provide the signal processing implementation.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_decimator.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_decimator.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_decimator.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief synchronous N:1 input to output with history
- * \ingroup internal
+ * \ingroup base_blk
*
* Override work to provide the signal processing implementation.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_sync_interpolator.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief synchronous 1:N input to output with history
- * \ingroup internal
+ * \ingroup base_blk
*
* Override work to provide the signal processing implementation.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_top_block.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_top_block.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_top_block.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -31,7 +31,7 @@
/*!
*\brief Top-level hierarchical block representing a flowgraph
- * \ingroup internal
+ * \ingroup container_blk
*
*/
class gr_top_block : public gr_hier_block2
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief abstract class to implement doubly mapped virtual memory circular
buffers
- * \ingroup base
+ * \ingroup internal
*/
class gr_vmcircbuf {
protected:
Modified:
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h
===================================================================
---
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h
2009-05-22 12:42:51 UTC (rev 11084)
+++
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_createfilemapping.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -30,7 +30,7 @@
#endif
/*!
* \brief concrete class to implement circular buffers with mmap and shm_open
- * \ingroup base
+ * \ingroup internal
*/
class gr_vmcircbuf_createfilemapping : public gr_vmcircbuf
{
Modified:
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_shm_open.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief concrete class to implement circular buffers with mmap and shm_open
- * \ingroup base
+ * \ingroup internal
*/
class gr_vmcircbuf_mmap_shm_open : public gr_vmcircbuf {
public:
Modified:
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_mmap_tmpfile.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief concrete class to implement circular buffers with mmap and shm_open
- * \ingroup base
+ * \ingroup internal
*/
class gr_vmcircbuf_mmap_tmpfile : public gr_vmcircbuf {
public:
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h
2009-05-22 12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_vmcircbuf_sysv_shm.h
2009-05-22 16:11:15 UTC (rev 11085)
@@ -27,7 +27,7 @@
/*!
* \brief concrete class to implement circular buffers with mmap and shm_open
- * \ingroup base
+ * \ingroup internal
*/
class gr_vmcircbuf_sysv_shm : public gr_vmcircbuf {
public:
Modified: gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h
===================================================================
--- gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -43,7 +43,6 @@
* \param neg_accum_max Minimum integer value allowed for the internal
reference. Default: "-32767" (-2^15 + 1 or MINSHORT+1)
*
*/
-
cvsd_decode_bs_sptr cvsd_make_decode_bs (short min_step=10,
short max_step=1280,
double step_decay=0.9990234375,
@@ -58,7 +57,7 @@
* is modeled after the CVSD encoder/decoder specifications defined in the
* Bluetooth standard.
*
- * \ingroup block
+ * \ingroup vocoder
*
* CVSD is a method for encoding speech that seeks to reduce the
* bandwidth required for digital voice transmission. CVSD takes
Modified: gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h
===================================================================
--- gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -58,7 +58,7 @@
* is modeled after the CVSD encoder/decoder specifications defined in the
* Bluetooth standard.
*
- * \ingroup block
+ * \ingroup vocoder
*
* CVSD is a method for encoding speech that seeks to reduce the
* bandwidth required for digital voice transmission. CVSD takes
Modified: gnuradio/trunk/gr-gcell/src/gcell_fft_vcc.h
===================================================================
--- gnuradio/trunk/gr-gcell/src/gcell_fft_vcc.h 2009-05-22 12:42:51 UTC (rev
11084)
+++ gnuradio/trunk/gr-gcell/src/gcell_fft_vcc.h 2009-05-22 16:11:15 UTC (rev
11085)
@@ -35,7 +35,7 @@
/*!
* \brief Compute forward or reverse FFT. complex vector in / complex vector
out.
- * \ingroup dft
+ * \ingroup dft_blk
*
* Concrete class that uses gcell to offload FFT to SPEs.
*/
Modified: gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h
===================================================================
--- gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -31,6 +31,7 @@
/*!
* \brief GSM 06.10 Full Rate Vocoder Decoder
+ * \ingroup vocoder
*/
class gsm_fr_decode_ps : public gr_sync_interpolator {
struct gsm_state *d_gsm;
Modified: gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h
===================================================================
--- gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -31,7 +31,7 @@
/*!
* \brief GSM 06.10 Full Rate Vocoder Encoder
- * \ingroup block
+ * \ingroup vocoder
*
* shorts in; 33 byte packets out
*/
Modified: gnuradio/trunk/gr-usrp/src/usrp_sink_c.h
===================================================================
--- gnuradio/trunk/gr-usrp/src/usrp_sink_c.h 2009-05-22 12:42:51 UTC (rev
11084)
+++ gnuradio/trunk/gr-usrp/src/usrp_sink_c.h 2009-05-22 16:11:15 UTC (rev
11085)
@@ -44,7 +44,9 @@
/*!
- * \brief interface to Universal Software Radio Peripheral Tx path (Rev 1)
+ * \brief Interface to Universal Software Radio Peripheral Tx path
+ * \ingroup usrp
+ * \ingroup sink_blk
*
* input: gr_complex
*/
Modified: gnuradio/trunk/gr-usrp/src/usrp_sink_s.h
===================================================================
--- gnuradio/trunk/gr-usrp/src/usrp_sink_s.h 2009-05-22 12:42:51 UTC (rev
11084)
+++ gnuradio/trunk/gr-usrp/src/usrp_sink_s.h 2009-05-22 16:11:15 UTC (rev
11085)
@@ -43,7 +43,9 @@
) throw (std::runtime_error);
/*!
- * \brief interface to Universal Software Radio Peripheral Tx path (Rev 1)
+ * \brief Interface to Universal Software Radio Peripheral Tx path
+ * \ingroup usrp
+ * \ingroup sink_blk
*
* input: short
*/
Modified: gnuradio/trunk/gr-usrp/src/usrp_source_c.h
===================================================================
--- gnuradio/trunk/gr-usrp/src/usrp_source_c.h 2009-05-22 12:42:51 UTC (rev
11084)
+++ gnuradio/trunk/gr-usrp/src/usrp_source_c.h 2009-05-22 16:11:15 UTC (rev
11085)
@@ -48,7 +48,11 @@
) throw (std::runtime_error);
/*!
- * \brief interface to Universal Software Radio Peripheral Rx path (Rev 1)
+ * \brief Interface to Universal Software Radio Peripheral Rx path
+ * \ingroup usrp
+ * \ingroup source_blk
+ *
+ * output: 1 stream of complex<float>
*/
class usrp_source_c : public usrp_source_base {
private:
Modified: gnuradio/trunk/gr-usrp/src/usrp_source_s.h
===================================================================
--- gnuradio/trunk/gr-usrp/src/usrp_source_s.h 2009-05-22 12:42:51 UTC (rev
11084)
+++ gnuradio/trunk/gr-usrp/src/usrp_source_s.h 2009-05-22 16:11:15 UTC (rev
11085)
@@ -48,7 +48,9 @@
) throw (std::runtime_error);
/*!
- * \brief interface to Universal Software Radio Peripheral Rx path (Rev 1)
+ * \brief Interface to Universal Software Radio Peripheral Rx path
+ * \ingroup usrp
+ * \ingroup source_blk
*
* output: 1 stream of short
*/
Modified: gnuradio/trunk/gr-usrp2/src/usrp2_sink_16sc.h
===================================================================
--- gnuradio/trunk/gr-usrp2/src/usrp2_sink_16sc.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/gr-usrp2/src/usrp2_sink_16sc.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -33,6 +33,10 @@
const std::string &mac="")
throw (std::runtime_error);
+/*!
+ * \ingroup sink_blk
+ * \ingroup usrp2
+ */
class usrp2_sink_16sc : public usrp2_sink_base
{
private:
Modified: gnuradio/trunk/gr-usrp2/src/usrp2_sink_32fc.h
===================================================================
--- gnuradio/trunk/gr-usrp2/src/usrp2_sink_32fc.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/gr-usrp2/src/usrp2_sink_32fc.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -33,6 +33,10 @@
const std::string &mac="")
throw (std::runtime_error);
+/*!
+ * \ingroup sink_blk
+ * \ingroup usrp2
+ */
class usrp2_sink_32fc : public usrp2_sink_base
{
private:
Modified: gnuradio/trunk/gr-usrp2/src/usrp2_source_16sc.h
===================================================================
--- gnuradio/trunk/gr-usrp2/src/usrp2_source_16sc.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/gr-usrp2/src/usrp2_source_16sc.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -33,6 +33,10 @@
const std::string &mac="")
throw (std::runtime_error);
+/*!
+ * \ingroup source_blk
+ * \ingroup usrp2
+ */
class usrp2_source_16sc : public usrp2_source_base
{
private:
Modified: gnuradio/trunk/gr-usrp2/src/usrp2_source_32fc.h
===================================================================
--- gnuradio/trunk/gr-usrp2/src/usrp2_source_32fc.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/gr-usrp2/src/usrp2_source_32fc.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -33,6 +33,10 @@
const std::string &mac="")
throw (std::runtime_error);
+/*!
+ * \ingroup source_blk
+ * \ingroup usrp2
+ */
class usrp2_source_32fc : public usrp2_source_base
{
private:
Modified: gnuradio/trunk/usrp/host/lib/legacy/db_base.h
===================================================================
--- gnuradio/trunk/usrp/host/lib/legacy/db_base.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/usrp/host/lib/legacy/db_base.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -42,6 +42,10 @@
/******************************************************************************/
+/*!
+ * \brief Abstract base class for all USRP daughterboards
+ * \ingroup usrp
+ */
class db_base
{
protected:
Modified: gnuradio/trunk/usrp/host/lib/legacy/usrp_basic.h
===================================================================
--- gnuradio/trunk/usrp/host/lib/legacy/usrp_basic.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/usrp/host/lib/legacy/usrp_basic.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -57,6 +57,7 @@
/*!
* \brief abstract base class for usrp operations
+ * \ingroup usrp
*/
class usrp_basic : boost::noncopyable
{
@@ -764,6 +765,7 @@
/*!
* \brief class for accessing the receive side of the USRP
+ * \ingroup usrp
*/
class usrp_basic_rx : public usrp_basic
{
@@ -871,6 +873,7 @@
/*!
* \brief class for accessing the transmit side of the USRP
+ * \ingroup usrp
*/
class usrp_basic_tx : public usrp_basic
{
Modified: gnuradio/trunk/usrp/host/lib/legacy/usrp_standard.h
===================================================================
--- gnuradio/trunk/usrp/host/lib/legacy/usrp_standard.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/usrp/host/lib/legacy/usrp_standard.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -33,6 +33,9 @@
typedef boost::shared_ptr<usrp_standard_tx> usrp_standard_tx_sptr;
typedef boost::shared_ptr<usrp_standard_rx> usrp_standard_rx_sptr;
+/*!
+ * \ingroup usrp
+ */
class usrp_standard_common
{
int d_fpga_caps; // capability register val
@@ -79,9 +82,11 @@
};
/*!
- * \brief standard usrp RX class.
+ * \brief The C++ interface the receive side of the USRP
+ * \ingroup usrp
*
- * Assumes digital down converter in FPGA
+ * This is the recommended interface to USRP receive functionality
+ * for applications that use the USRP but not GNU Radio.
*/
class usrp_standard_rx : public usrp_basic_rx, public usrp_standard_common
{
@@ -272,8 +277,12 @@
// ----------------------------------------------------------------
/*!
- * \brief standard usrp TX class.
+ * \brief The C++ interface the transmit side of the USRP
+ * \ingroup usrp
*
+ * This is the recommended interface to USRP transmit functionality
+ * for applications that use the USRP but not GNU Radio.
+ *
* Uses digital upconverter (coarse & fine modulators) in AD9862...
*/
class usrp_standard_tx : public usrp_basic_tx, public usrp_standard_common
Modified: gnuradio/trunk/usrp2/host/include/usrp2/metadata.h
===================================================================
--- gnuradio/trunk/usrp2/host/include/usrp2/metadata.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/usrp2/host/include/usrp2/metadata.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -27,6 +27,7 @@
/*!
* \brief metadata associated with received frames
+ * \ingroup usrp2
*/
struct rx_metadata {
uint32_t word0; //< debugging, extensions
@@ -43,6 +44,7 @@
/*!
* \brief metadata associated with transmitted frames
+ * \ingroup usrp2
*/
struct tx_metadata {
fpga_timestamp timestamp; //< time to transmit first
sample of frame
Modified: gnuradio/trunk/usrp2/host/include/usrp2/rx_nop_handler.h
===================================================================
--- gnuradio/trunk/usrp2/host/include/usrp2/rx_nop_handler.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/usrp2/host/include/usrp2/rx_nop_handler.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -23,6 +23,8 @@
#include <boost/shared_ptr.hpp>
/*!
+ * \ingroup usrp2
+ *
* Base class for receive handlers that must copy into potentially limited
* range destination buffers.
*
Modified: gnuradio/trunk/usrp2/host/include/usrp2/rx_sample_handler.h
===================================================================
--- gnuradio/trunk/usrp2/host/include/usrp2/rx_sample_handler.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/usrp2/host/include/usrp2/rx_sample_handler.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -26,6 +26,7 @@
/*!
* \brief Abstract function object called to handle received data blocks.
+ * \ingroup usrp2
*
* An object derived from this class is passed to usrp2::rx_samples
* to process the received frames of samples.
Modified: gnuradio/trunk/usrp2/host/include/usrp2/tune_result.h
===================================================================
--- gnuradio/trunk/usrp2/host/include/usrp2/tune_result.h 2009-05-22
12:42:51 UTC (rev 11084)
+++ gnuradio/trunk/usrp2/host/include/usrp2/tune_result.h 2009-05-22
16:11:15 UTC (rev 11085)
@@ -21,6 +21,9 @@
namespace usrp2 {
+ /*
+ * \ingroup usrp2
+ */
class tune_result
{
public:
Modified: gnuradio/trunk/usrp2/host/include/usrp2/usrp2.h
===================================================================
--- gnuradio/trunk/usrp2/host/include/usrp2/usrp2.h 2009-05-22 12:42:51 UTC
(rev 11084)
+++ gnuradio/trunk/usrp2/host/include/usrp2/usrp2.h 2009-05-22 16:11:15 UTC
(rev 11085)
@@ -68,6 +68,10 @@
static const int GPIO_TX_BANK = 0;
static const int GPIO_RX_BANK = 1;
+ /*!
+ * \brief standard C++ interface to USRP2
+ * \ingroup usrp2
+ */
class usrp2 : boost::noncopyable
{
public:
Modified: gnuradio/trunk/usrp2/host/lib/eth_buffer.cc
===================================================================
--- gnuradio/trunk/usrp2/host/lib/eth_buffer.cc 2009-05-22 12:42:51 UTC (rev
11084)
+++ gnuradio/trunk/usrp2/host/lib/eth_buffer.cc 2009-05-22 16:11:15 UTC (rev
11085)
@@ -1,6 +1,6 @@
/* -*- c++ -*- */
/*
- * Copyright 2008 Free Software Foundation, Inc.
+ * Copyright 2008,2009 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Commit-gnuradio] r11085 - in gnuradio/trunk: docs/doxygen/other gnuradio-core/src/lib/filter gnuradio-core/src/lib/general gnuradio-core/src/lib/gengen gnuradio-core/src/lib/io gnuradio-core/src/lib/runtime gr-cvsd-vocoder/src/lib gr-gcell/src gr-gsm-fr-vocoder/src/lib gr-usrp/src gr-usrp2/src usrp/host/lib/legacy usrp2/host/include/usrp2 usrp2/host/lib,
eb <=