diff options
| author | Tom Rondeau <trondeau@vt.edu> | 2013-04-04 11:50:35 -0400 |
|---|---|---|
| committer | Tom Rondeau <trondeau@vt.edu> | 2013-04-04 12:37:40 -0400 |
| commit | 8b1303bbb0bf72569a5149082796f50b6e8f9a5b (patch) | |
| tree | 5809962a19338db21f28957535529552d12992a1 /gr-digital/include/digital | |
| parent | 2930f1b4265b794599d814e9a3d68fd03bde010f (diff) | |
docs: fixes for merge conflicts and differences between master/next.
Diffstat (limited to 'gr-digital/include/digital')
54 files changed, 138 insertions, 122 deletions
diff --git a/gr-digital/include/digital/additive_scrambler_bb.h b/gr-digital/include/digital/additive_scrambler_bb.h index 345bd45dc8..c0ae70e7b1 100644 --- a/gr-digital/include/digital/additive_scrambler_bb.h +++ b/gr-digital/include/digital/additive_scrambler_bb.h @@ -32,6 +32,7 @@ namespace gr { /*! * \ingroup coding_blk * + * \details * Scramble an input stream using an LFSR. This block works on the * LSB only of the input data stream, i.e., on an "unpacked * binary" stream, and produces the same format on its output. diff --git a/gr-digital/include/digital/binary_slicer_fb.h b/gr-digital/include/digital/binary_slicer_fb.h index f56b48a633..47e0246094 100644 --- a/gr-digital/include/digital/binary_slicer_fb.h +++ b/gr-digital/include/digital/binary_slicer_fb.h @@ -31,9 +31,9 @@ namespace gr { /*! * \brief slice float binary symbol outputting 1 bit output - * \ingroup converter_blk - * \ingroup digital + * \ingroup symbol_coding_blk * + * \details * x < 0 --> 0 * x >= 0 --> 1 */ diff --git a/gr-digital/include/digital/clock_recovery_mm_cc.h b/gr-digital/include/digital/clock_recovery_mm_cc.h index ec121c0fdf..a7917e528a 100644 --- a/gr-digital/include/digital/clock_recovery_mm_cc.h +++ b/gr-digital/include/digital/clock_recovery_mm_cc.h @@ -31,9 +31,9 @@ namespace gr { /*! * \brief Mueller and Müller (M&M) based clock recovery block with complex input, complex output. - * \ingroup sync_blk - * \ingroup digital + * \ingroup synchronizers_blk * + * \details * This implements the Mueller and Müller (M&M) discrete-time * error-tracking synchronizer. * diff --git a/gr-digital/include/digital/clock_recovery_mm_ff.h b/gr-digital/include/digital/clock_recovery_mm_ff.h index 556fe0a876..491f3ec21a 100644 --- a/gr-digital/include/digital/clock_recovery_mm_ff.h +++ b/gr-digital/include/digital/clock_recovery_mm_ff.h @@ -31,9 +31,9 @@ namespace gr { /*! * \brief Mueller and Müller (M&M) based clock recovery block with float input, float output. - * \ingroup sync_blk - * \ingroup digital + * \ingroup synchronizers_blk * + * \details * This implements the Mueller and Müller (M&M) discrete-time * error-tracking synchronizer. * diff --git a/gr-digital/include/digital/cma_equalizer_cc.h b/gr-digital/include/digital/cma_equalizer_cc.h index 60c58db1e1..0ccd1c21ba 100644 --- a/gr-digital/include/digital/cma_equalizer_cc.h +++ b/gr-digital/include/digital/cma_equalizer_cc.h @@ -31,9 +31,9 @@ namespace gr { /*! * \brief Implements constant modulus adaptive filter on complex stream - * \ingroup eq_blk - * \ingroup digital + * \ingroup equalizers_blk * + * \details * The error value and tap update equations (for p=2) can be found in: * * D. Godard, "Self-Recovering Equalization and Carrier Tracking diff --git a/gr-digital/include/digital/constellation.h b/gr-digital/include/digital/constellation.h index 48a06ed8a8..a5e490b428 100644 --- a/gr-digital/include/digital/constellation.h +++ b/gr-digital/include/digital/constellation.h @@ -43,8 +43,9 @@ namespace gr { /*! * \brief An abstracted constellation object - * \ingroup digital + * \ingroup symbol_coding_blk * + * \details * The constellation objects hold the necessary information to pass * around constellation information for modulators and * demodulators. These objects contain the mapping between the bits diff --git a/gr-digital/include/digital/constellation_decoder_cb.h b/gr-digital/include/digital/constellation_decoder_cb.h index 01b35db905..39cc6ac822 100644 --- a/gr-digital/include/digital/constellation_decoder_cb.h +++ b/gr-digital/include/digital/constellation_decoder_cb.h @@ -32,9 +32,9 @@ namespace gr { /*! * \brief Constellation Decoder - * \ingroup coding_blk - * \ingroup digital + * \ingroup symbol_coding_blk * + * \details * Decode a constellation's points from a complex space to * (unpacked) bits based on the map of the \p consetllation * object. diff --git a/gr-digital/include/digital/constellation_receiver_cb.h b/gr-digital/include/digital/constellation_receiver_cb.h index b1c415ea09..0ade7fc217 100644 --- a/gr-digital/include/digital/constellation_receiver_cb.h +++ b/gr-digital/include/digital/constellation_receiver_cb.h @@ -33,10 +33,9 @@ namespace gr { /*! * \brief This block takes care of receiving generic modulated signals * through phase, frequency, and symbol synchronization. - * \ingroup sync_blk - * \ingroup demod_blk - * \ingroup digital + * \ingroup modulators_blk * + * \details * This block takes care of receiving generic modulated signals * through phase, frequency, and symbol synchronization. It * performs carrier frequency and phase locking as well as symbol diff --git a/gr-digital/include/digital/correlate_access_code_bb.h b/gr-digital/include/digital/correlate_access_code_bb.h index c2ef788a37..12c0f39961 100644 --- a/gr-digital/include/digital/correlate_access_code_bb.h +++ b/gr-digital/include/digital/correlate_access_code_bb.h @@ -32,9 +32,10 @@ namespace gr { /*! * \brief Examine input for specified access code, one bit at a time. - * \ingroup sync_blk - * \ingroup digital + * \ingroup packet_operators_blk + * \ingroup deprecated_blk * + * \details * input: stream of bits, 1 bit per input byte (data in LSB) * output: stream of bits, 2 bits per output byte (data in LSB, flag in next higher bit) * diff --git a/gr-digital/include/digital/correlate_access_code_tag_bb.h b/gr-digital/include/digital/correlate_access_code_tag_bb.h index 0c51f3aead..5e04aa0b6e 100644 --- a/gr-digital/include/digital/correlate_access_code_tag_bb.h +++ b/gr-digital/include/digital/correlate_access_code_tag_bb.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief Examine input for specified access code, one bit at a time. - * \ingroup sync_blk + * \ingroup packet_operators_blk * + * \details * input: stream of bits, 1 bit per input byte (data in LSB) * output: unaltered stream of bits (plus tags) * diff --git a/gr-digital/include/digital/costas_loop_cc.h b/gr-digital/include/digital/costas_loop_cc.h index 252f39914a..8ac0444cb8 100644 --- a/gr-digital/include/digital/costas_loop_cc.h +++ b/gr-digital/include/digital/costas_loop_cc.h @@ -32,9 +32,9 @@ namespace gr { /*! * \brief A Costas loop carrier recovery module. - * \ingroup sync_blk - * \ingroup digital - * + * \ingroup synchronizers_blk + * + * \details * The Costas loop locks to the center frequency of a signal and * downconverts it to baseband. The second (order=2) order loop * is used for BPSK where the real part of the output signal is diff --git a/gr-digital/include/digital/cpmmod_bc.h b/gr-digital/include/digital/cpmmod_bc.h index 7d91915cdd..85fb0fae81 100644 --- a/gr-digital/include/digital/cpmmod_bc.h +++ b/gr-digital/include/digital/cpmmod_bc.h @@ -32,10 +32,9 @@ namespace gr { /*! * \brief Generic CPM modulator + * \ingroup modulators_blk * - * \ingroup modulation_blk - * \ingroup digital - * + * \details * Examples: * - Setting h = 0.5, L = 1, type = LREC yields MSK. * - Setting h = 0.5, type = GAUSSIAN and beta = 0.3 yields GMSK diff --git a/gr-digital/include/digital/crc32.h b/gr-digital/include/digital/crc32.h index b84dd6832d..180719bf73 100644 --- a/gr-digital/include/digital/crc32.h +++ b/gr-digital/include/digital/crc32.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief update running CRC-32 - * \ingroup digital + * \ingroup packet_operators_blk * + * \details * Update a running CRC with the bytes buf[0..len-1] The CRC * should be initialized to all 1's, and the transmitted value is * the 1's complement of the final running CRC. The resulting CRC diff --git a/gr-digital/include/digital/crc32_bb.h b/gr-digital/include/digital/crc32_bb.h index 4bfac76070..52f056c716 100644 --- a/gr-digital/include/digital/crc32_bb.h +++ b/gr-digital/include/digital/crc32_bb.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief Byte-stream CRC block - * \ingroup digital + * \ingroup packet_operators_blk * + * \details * Input: stream of bytes, which form a packet. The first byte of the packet * has a tag with key "length" and the value being the number of bytes in the * packet. diff --git a/gr-digital/include/digital/descrambler_bb.h b/gr-digital/include/digital/descrambler_bb.h index 512efc503a..da8a3b0e88 100644 --- a/gr-digital/include/digital/descrambler_bb.h +++ b/gr-digital/include/digital/descrambler_bb.h @@ -33,6 +33,7 @@ namespace gr { * \brief Descramber an input stream using an LFSR. * \ingroup coding_blk * + * \details * Descramble an input stream using an LFSR. This block works on * the LSB only of the input data stream, i.e., on an "unpacked * binary" stream, and produces the same format on its output. diff --git a/gr-digital/include/digital/diff_decoder_bb.h b/gr-digital/include/digital/diff_decoder_bb.h index 88b9f754ef..0b28b2a553 100644 --- a/gr-digital/include/digital/diff_decoder_bb.h +++ b/gr-digital/include/digital/diff_decoder_bb.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Differential encoder: y[0] = (x[0] - x[-1]) % M - * \ingroup coding_blk + * \ingroup symbol_coding_blk * + * \details * Uses current and previous symbols and the alphabet modulus to * perform differential decoding. */ diff --git a/gr-digital/include/digital/diff_encoder_bb.h b/gr-digital/include/digital/diff_encoder_bb.h index 08fc6bef8c..ef9d0970a0 100644 --- a/gr-digital/include/digital/diff_encoder_bb.h +++ b/gr-digital/include/digital/diff_encoder_bb.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Differential decoder: y[0] = (x[0] + y[-1]) % M - * \ingroup coding_blk + * \ingroup symbol_coding_blk * + * \details * Uses current and previous symbols and the alphabet modulus to * perform differential encoding. */ diff --git a/gr-digital/include/digital/diff_phasor_cc.h b/gr-digital/include/digital/diff_phasor_cc.h index bf5a0a6326..e2bf2bce59 100644 --- a/gr-digital/include/digital/diff_phasor_cc.h +++ b/gr-digital/include/digital/diff_phasor_cc.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief Differential decoding based on phase change. - * \ingroup coding_blk + * \ingroup symbol_coding_blk * + * \details * Uses the phase difference between two symbols to determine the * output symbol: * diff --git a/gr-digital/include/digital/fll_band_edge_cc.h b/gr-digital/include/digital/fll_band_edge_cc.h index 7b823630ed..0bf3471112 100644 --- a/gr-digital/include/digital/fll_band_edge_cc.h +++ b/gr-digital/include/digital/fll_band_edge_cc.h @@ -31,12 +31,10 @@ namespace gr { namespace digital { /*! - * \class digital_fll_band_edge_cc * \brief Frequency Lock Loop using band-edge filters + * \ingroup synchronizers_blk * - * \ingroup general - * \ingroup digital - * + * \details * The frequency lock loop derives a band-edge filter that covers * the upper and lower bandwidths of a digitally-modulated * signal. The bandwidth range is determined by the excess diff --git a/gr-digital/include/digital/framer_sink_1.h b/gr-digital/include/digital/framer_sink_1.h index 13e649b1f2..b562778704 100644 --- a/gr-digital/include/digital/framer_sink_1.h +++ b/gr-digital/include/digital/framer_sink_1.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief Given a stream of bits and access_code flags, assemble packets. - * \ingroup sink_blk + * \ingroup packet_operators_blk * + * \details * input: stream of bytes from digital_correlate_access_code_bb * output: none. Pushes assembled packet into target queue * diff --git a/gr-digital/include/digital/glfsr.h b/gr-digital/include/digital/glfsr.h index 211956e842..4c7701d7ee 100644 --- a/gr-digital/include/digital/glfsr.h +++ b/gr-digital/include/digital/glfsr.h @@ -30,11 +30,11 @@ namespace gr { /*! * \brief Galois Linear Feedback Shift Register using specified polynomial mask - * \ingroup misc + * \ingroup waveform_generators_blk * + * \details * Generates a maximal length pseudo-random sequence of length 2^degree-1 */ - class DIGITAL_API glfsr { private: diff --git a/gr-digital/include/digital/glfsr_source_b.h b/gr-digital/include/digital/glfsr_source_b.h index 9e245875d4..7fefb747aa 100644 --- a/gr-digital/include/digital/glfsr_source_b.h +++ b/gr-digital/include/digital/glfsr_source_b.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Galois LFSR pseudo-random source - * \ingroup source_blk + * \ingroup waveform_generators_blk */ class DIGITAL_API glfsr_source_b : virtual public gr_sync_block { diff --git a/gr-digital/include/digital/glfsr_source_f.h b/gr-digital/include/digital/glfsr_source_f.h index 4feb3562b3..e591498d8c 100644 --- a/gr-digital/include/digital/glfsr_source_f.h +++ b/gr-digital/include/digital/glfsr_source_f.h @@ -31,7 +31,7 @@ namespace gr { /*! * \brief Galois LFSR pseudo-random source generating float outputs -1.0 - 1.0. - * \ingroup source_blk + * \ingroup waveform_generators_blk */ class DIGITAL_API glfsr_source_f : virtual public gr_sync_block { diff --git a/gr-digital/include/digital/kurtotic_equalizer_cc.h b/gr-digital/include/digital/kurtotic_equalizer_cc.h index 2753cb3cce..d32533b76e 100644 --- a/gr-digital/include/digital/kurtotic_equalizer_cc.h +++ b/gr-digital/include/digital/kurtotic_equalizer_cc.h @@ -31,9 +31,9 @@ namespace gr { /*! * \brief Implements a kurtosis-based adaptive equalizer on complex stream - * \ingroup eq_blk - * \ingroup digital + * \ingroup equalizers_blk * + * \details * WARNING: This block does not yet work. * * "Y. Guo, J. Zhao, Y. Sun, "Sign kurtosis maximization based blind diff --git a/gr-digital/include/digital/lfsr.h b/gr-digital/include/digital/lfsr.h index 2319961257..0dd419b791 100644 --- a/gr-digital/include/digital/lfsr.h +++ b/gr-digital/include/digital/lfsr.h @@ -35,6 +35,7 @@ namespace gr { * polynomial mask * \ingroup misc * + * \details * Generates a maximal length pseudo-random sequence of length * 2^degree-1 * diff --git a/gr-digital/include/digital/lms_dd_equalizer_cc.h b/gr-digital/include/digital/lms_dd_equalizer_cc.h index 8084396759..7286c9ad3c 100644 --- a/gr-digital/include/digital/lms_dd_equalizer_cc.h +++ b/gr-digital/include/digital/lms_dd_equalizer_cc.h @@ -32,9 +32,9 @@ namespace gr { /*! * \brief Least-Mean-Square Decision Directed Equalizer (complex in/out) - * \ingroup eq_blk - * \ingroup digital + * \ingroup equalizers_blk * + * \details * This block implements an LMS-based decision-directed equalizer. * It uses a set of weights, w, to correlate against the inputs, * u, and a decisions is then made from this output. The error in diff --git a/gr-digital/include/digital/map_bb.h b/gr-digital/include/digital/map_bb.h index 6a380e2cc1..0a55a61213 100644 --- a/gr-digital/include/digital/map_bb.h +++ b/gr-digital/include/digital/map_bb.h @@ -31,8 +31,9 @@ namespace gr { /*! * \brief output[i] = map[input[i]] - * \ingroup coding_blk + * \ingroup symbol_coding_blk * + * \details * This block maps an incoming signal to the value in the map. * The block expects that the incoming signal has a maximum * value of len(map)-1. diff --git a/gr-digital/include/digital/mpsk_receiver_cc.h b/gr-digital/include/digital/mpsk_receiver_cc.h index 14094e25b7..9470cd8376 100644 --- a/gr-digital/include/digital/mpsk_receiver_cc.h +++ b/gr-digital/include/digital/mpsk_receiver_cc.h @@ -32,10 +32,9 @@ namespace gr { /*! * \brief This block takes care of receiving M-PSK modulated * signals through phase, frequency, and symbol synchronization. - * \ingroup sync_blk - * \ingroup demod_blk - * \ingroup digital + * \ingroup synchronizers_blk * + * \details * 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 diff --git a/gr-digital/include/digital/mpsk_snr_est.h b/gr-digital/include/digital/mpsk_snr_est.h index 69c03430d3..f9edcbd05a 100644 --- a/gr-digital/include/digital/mpsk_snr_est.h +++ b/gr-digital/include/digital/mpsk_snr_est.h @@ -29,10 +29,11 @@ namespace gr { namespace digital { - //! Enum for the type of SNR estimator to select - /*! \ingroup snr_blk - * \anchor ref_snr_est_types + /*! + * \brief A block for computing SNR of a signal. + * \ingroup measurement_tools_blk * + * \details * Below are some ROUGH estimates of what values of SNR each of * these types of estimators is good for. In general, these offer * a trade-off between accuracy and performance. diff --git a/gr-digital/include/digital/mpsk_snr_est_cc.h b/gr-digital/include/digital/mpsk_snr_est_cc.h index c2d1fd43d2..14e8ca3b20 100644 --- a/gr-digital/include/digital/mpsk_snr_est_cc.h +++ b/gr-digital/include/digital/mpsk_snr_est_cc.h @@ -30,22 +30,24 @@ namespace gr { namespace digital { - //! \brief A block for computing SNR of a signal. - /*! \ingroup snr_blk + /*! + * \brief A block for computing SNR of a signal. + * \ingroup measurement_tools_blk * - * This block can be used to monitor and retrieve estimations of - * the signal SNR. It is designed to work in a flowgraph and - * passes all incoming data along to its output. + * \details + * This block can be used to monitor and retrieve estimations of + * the signal SNR. It is designed to work in a flowgraph and + * passes all incoming data along to its output. * - * The block is designed for use with M-PSK signals - * especially. The type of estimator is specified as the \p type - * parameter in the constructor. The estimators tend to trade off - * performance for accuracy, although experimentation should be - * done to figure out the right approach for a given - * implementation. Further, the current set of estimators are - * designed and proven theoretically under AWGN conditions; some - * amount of error should be assumed and/or estimated for real - * channel conditions. + * The block is designed for use with M-PSK signals + * especially. The type of estimator is specified as the \p type + * parameter in the constructor. The estimators tend to trade off + * performance for accuracy, although experimentation should be + * done to figure out the right approach for a given + * implementation. Further, the current set of estimators are + * designed and proven theoretically under AWGN conditions; some + * amount of error should be assumed and/or estimated for real + * channel conditions. */ class DIGITAL_API mpsk_snr_est_cc : virtual public gr_sync_block { @@ -55,9 +57,7 @@ namespace gr { /*! Factory function returning shared pointer of this class * - * Parameters: - * - * \param type: the type of estimator to use \ref ref_snr_est_types + * \param type: the type of estimator to use gr::digital::snr_est_type_t * "snr_est_type_t" for details about the available types * \param tag_nsamples: after this many samples, a tag containing * the SNR (key='snr') will be sent diff --git a/gr-digital/include/digital/ofdm_carrier_allocator_cvc.h b/gr-digital/include/digital/ofdm_carrier_allocator_cvc.h index 9c743e66b3..2eaeb75611 100644 --- a/gr-digital/include/digital/ofdm_carrier_allocator_cvc.h +++ b/gr-digital/include/digital/ofdm_carrier_allocator_cvc.h @@ -34,6 +34,7 @@ namespace gr { * \brief Create frequency domain OFDM symbols from complex values, add pilots. * \ingroup ofdm_blk * + * \details * This block turns a stream of complex, scalar modulation symbols into vectors * which are the input for an IFFT in an OFDM transmitter. It also supports the * possibility of placing pilot symbols onto the carriers. diff --git a/gr-digital/include/digital/ofdm_chanest_vcvc.h b/gr-digital/include/digital/ofdm_chanest_vcvc.h index 0c29d630da..0607743d57 100644 --- a/gr-digital/include/digital/ofdm_chanest_vcvc.h +++ b/gr-digital/include/digital/ofdm_chanest_vcvc.h @@ -32,8 +32,9 @@ namespace gr { /*! * \brief Estimate channel and coarse frequency offset for OFDM from preambles * \ingroup ofdm_blk - * \ingroup sync_blk + * \ingroup synchronizers_blk * + * \details * Input: OFDM symbols (in frequency domain). The first one (or two) symbols are expected * to be synchronisation symbols, which are used to estimate the coarse freq offset * and the initial equalizer taps (these symbols are removed from the stream). diff --git a/gr-digital/include/digital/ofdm_cyclic_prefixer.h b/gr-digital/include/digital/ofdm_cyclic_prefixer.h index 6292d62697..f8e45edd90 100644 --- a/gr-digital/include/digital/ofdm_cyclic_prefixer.h +++ b/gr-digital/include/digital/ofdm_cyclic_prefixer.h @@ -33,6 +33,7 @@ namespace gr { * \brief Adds a cyclic prefix and performs pulse shaping on OFDM symbols. * \ingroup ofdm_blk * + * \details * Input: OFDM symbols (in the time domain, i.e. after the IFFT). Optionally, * entire frames can be processed. In this case, \p len_tag_key must be * specified which holds the key of the tag that denotes how diff --git a/gr-digital/include/digital/ofdm_equalizer_base.h b/gr-digital/include/digital/ofdm_equalizer_base.h index c13c07f590..4e3a88d589 100644 --- a/gr-digital/include/digital/ofdm_equalizer_base.h +++ b/gr-digital/include/digital/ofdm_equalizer_base.h @@ -32,7 +32,7 @@ namespace gr { /* \brief Base class for implementation details of frequency-domain OFDM equalizers. * \ingroup ofdm_blk - * \ingroup eq_blk + * \ingroup equalizers_blk */ class DIGITAL_API ofdm_equalizer_base : public boost::enable_shared_from_this<ofdm_equalizer_base> diff --git a/gr-digital/include/digital/ofdm_equalizer_simpledfe.h b/gr-digital/include/digital/ofdm_equalizer_simpledfe.h index 9d286576bc..7bf6950965 100644 --- a/gr-digital/include/digital/ofdm_equalizer_simpledfe.h +++ b/gr-digital/include/digital/ofdm_equalizer_simpledfe.h @@ -31,8 +31,9 @@ namespace gr { /* \brief Simple decision feedback equalizer for OFDM. * \ingroup ofdm_blk - * \ingroup eq_blk + * \ingroup equalizers_blk * + * \details * Equalizes an OFDM signal symbol by symbol using knowledge of the * complex modulations symbols. * For every symbol, the following steps are performed: diff --git a/gr-digital/include/digital/ofdm_equalizer_static.h b/gr-digital/include/digital/ofdm_equalizer_static.h index 67586be6fb..6507479f4b 100644 --- a/gr-digital/include/digital/ofdm_equalizer_static.h +++ b/gr-digital/include/digital/ofdm_equalizer_static.h @@ -31,13 +31,16 @@ namespace gr { /* \brief Very simple static equalizer for OFDM. * \ingroup ofdm_blk - * \ingroup eq_blk + * \ingroup equalizers_blk * - * This is an extremely simple equalizer. It will only work for high-SNR, very, very - * slowly changing channels. - * It simply divides the signal with the currently known channel state. Whenever - * a pilot symbol comes around, it updates the channel state on that particular - * carrier by dividing the received symbol with the known pilot symbol. + * \details + * This is an extremely simple equalizer. It will only work for + * high-SNR, very, very slowly changing channels. + * + * It simply divides the signal with the currently known channel + * state. Whenever a pilot symbol comes around, it updates the + * channel state on that particular carrier by dividing the + * received symbol with the known pilot symbol. */ class DIGITAL_API ofdm_equalizer_static : public ofdm_equalizer_1d_pilots { diff --git a/gr-digital/include/digital/ofdm_frame_acquisition.h b/gr-digital/include/digital/ofdm_frame_acquisition.h index ec49b47f97..b8f8ff7662 100644 --- a/gr-digital/include/digital/ofdm_frame_acquisition.h +++ b/gr-digital/include/digital/ofdm_frame_acquisition.h @@ -33,9 +33,9 @@ namespace gr { /*! * \brief take a vector of complex constellation points in from an * FFT and performs a correlation and equalization. - * \ingroup demodulation_blk * \ingroup ofdm_blk * + * \details * 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 bins in the FFT output for the diff --git a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h index 97c9877f85..9cf24034a8 100644 --- a/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h +++ b/gr-digital/include/digital/ofdm_frame_equalizer_vcvc.h @@ -33,6 +33,7 @@ namespace gr { * \brief OFDM frame equalizer * \ingroup ofdm_blk * + * \details * Performs equalization in one or two dimensions on a tagged OFDM frame. * Input: a tagged series of OFDM symbols. * Output: The same as the input, but equalized. diff --git a/gr-digital/include/digital/ofdm_frame_sink.h b/gr-digital/include/digital/ofdm_frame_sink.h index 427d6eb460..ff31bad919 100644 --- a/gr-digital/include/digital/ofdm_frame_sink.h +++ b/gr-digital/include/digital/ofdm_frame_sink.h @@ -34,9 +34,9 @@ namespace gr { * \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_blk * \ingroup ofdm_blk * + * \details * 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 diff --git a/gr-digital/include/digital/ofdm_insert_preamble.h b/gr-digital/include/digital/ofdm_insert_preamble.h index 27db837e42..a9ad61e1d0 100644 --- a/gr-digital/include/digital/ofdm_insert_preamble.h +++ b/gr-digital/include/digital/ofdm_insert_preamble.h @@ -31,9 +31,10 @@ namespace gr { /*! * \brief insert "pre-modulated" preamble symbols before each payload. - * \ingroup sync_blk * \ingroup ofdm_blk + * \ingroup synchronizers_blk * + * \details * <pre> * input 1: stream of vectors of gr_complex [fft_length] * These are the modulated symbols of the payload. @@ -45,7 +46,6 @@ namespace gr { * * N.B., this implies that there must be at least 1 symbol in the payload. * - * * output 1: stream of vectors of gr_complex [fft_length] * These include the preamble symbols and the payload symbols. * @@ -54,9 +54,6 @@ namespace gr { * first symbol of the preamble.) It's a 1 if the corresponding * symbol is the first symbol, otherwise 0. * </pre> - * - * \param fft_length length of each symbol in samples. - * \param preamble vector of symbols that represent the pre-modulated preamble. */ class DIGITAL_API ofdm_insert_preamble : virtual public gr_block { diff --git a/gr-digital/include/digital/ofdm_mapper_bcv.h b/gr-digital/include/digital/ofdm_mapper_bcv.h index 1e541d2edb..49ae9adc92 100644 --- a/gr-digital/include/digital/ofdm_mapper_bcv.h +++ b/gr-digital/include/digital/ofdm_mapper_bcv.h @@ -34,9 +34,9 @@ namespace gr { * \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. - * \ingroup modulation_blk * \ingroup ofdm_blk * + * \details * Abstract class must be subclassed with specific mapping. */ class DIGITAL_API ofdm_mapper_bcv : virtual public gr_sync_block diff --git a/gr-digital/include/digital/ofdm_serializer_vcc.h b/gr-digital/include/digital/ofdm_serializer_vcc.h index c4dc36ec06..f02b0f85bb 100644 --- a/gr-digital/include/digital/ofdm_serializer_vcc.h +++ b/gr-digital/include/digital/ofdm_serializer_vcc.h @@ -33,6 +33,7 @@ namespace gr { * \brief Serializes complex modulations symbols from OFDM sub-carriers * \ingroup ofdm_blk * + * \details * This is the inverse block to the carrier_allocator_cvc. It outputs the * complex data symbols as a tagged stream, discarding the pilot symbols. * diff --git a/gr-digital/include/digital/ofdm_sync_sc_cfb.h b/gr-digital/include/digital/ofdm_sync_sc_cfb.h index 0c5c46f38d..84f3e704a3 100644 --- a/gr-digital/include/digital/ofdm_sync_sc_cfb.h +++ b/gr-digital/include/digital/ofdm_sync_sc_cfb.h @@ -33,8 +33,9 @@ namespace gr { /*! * \brief Schmidl & Cox synchronisation for OFDM * \ingroup ofdm_blk - * \ingroup sync_blk + * \ingroup synchronizers_blk * + * \details * Input: complex samples. * Output 0: Fine frequency offset, scaled by the OFDM symbol duration. * This is \f$\hat{\varphi}\f$ in [1]. The normalized frequency diff --git a/gr-digital/include/digital/packet_header_ofdm.h b/gr-digital/include/digital/packet_header_ofdm.h index 9f70900b49..50296a9a50 100644 --- a/gr-digital/include/digital/packet_header_ofdm.h +++ b/gr-digital/include/digital/packet_header_ofdm.h @@ -32,7 +32,6 @@ namespace gr { /*! * \brief Header utility for OFDM signals. * \ingroup ofdm_blk - * */ class DIGITAL_API packet_header_ofdm : public packet_header_default { diff --git a/gr-digital/include/digital/packet_sink.h b/gr-digital/include/digital/packet_sink.h index cca3d49cec..42f826535f 100644 --- a/gr-digital/include/digital/packet_sink.h +++ b/gr-digital/include/digital/packet_sink.h @@ -33,8 +33,9 @@ namespace gr { /*! * \brief process received bits looking for packet sync, header, * and process bits into packet - * \ingroup sink_blk + * \ingroup packet_operators_blk * + * \details * input: stream of symbols to be sliced. * * output: none. Pushes assembled packet into target queue diff --git a/gr-digital/include/digital/pfb_clock_sync_ccf.h b/gr-digital/include/digital/pfb_clock_sync_ccf.h index 0720a15a88..2cdb55ca4a 100644 --- a/gr-digital/include/digital/pfb_clock_sync_ccf.h +++ b/gr-digital/include/digital/pfb_clock_sync_ccf.h @@ -32,13 +32,10 @@ namespace gr { namespace digital { /*! - * \class digital_pfb_clock_sync_ccf - * * \brief Timing synchronizer using polyphase filterbanks + * \ingroup synchronizers_blk * - * \ingroup filter_blk - * \ingroup pfb_blk - * + * \details * This block performs timing synchronization for PAM signals by * minimizing the derivative of the filtered signal, which in turn * maximizes the SNR and minimizes ISI. diff --git a/gr-digital/include/digital/pfb_clock_sync_fff.h b/gr-digital/include/digital/pfb_clock_sync_fff.h index 5bc04e07d4..f0fc6df314 100644 --- a/gr-digital/include/digital/pfb_clock_sync_fff.h +++ b/gr-digital/include/digital/pfb_clock_sync_fff.h @@ -31,13 +31,10 @@ namespace gr { namespace digital { /*! - * \class digital_pfb_clock_sync_fff - * * \brief Timing synchronizer using polyphase filterbanks + * \ingroup synchronizers_blk * - * \ingroup filter_blk - * \ingroup pfb_blk - * + * \details * This block performs timing synchronization for PAM signals by * minimizing the derivative of the filtered signal, which in turn * maximizes the SNR and minimizes ISI. diff --git a/gr-digital/include/digital/pn_correlator_cc.h b/gr-digital/include/digital/pn_correlator_cc.h index 257cbbfe01..147983f892 100644 --- a/gr-digital/include/digital/pn_correlator_cc.h +++ b/gr-digital/include/digital/pn_correlator_cc.h @@ -31,9 +31,9 @@ namespace gr { /*! * \brief PN code sequential search correlator + * \ingroup synchronizers_blk * - * \ingroup sync_blk - * + * \details * Receives complex baseband signal, outputs complex correlation * against reference PN code, one sample per PN code period. The * PN sequence is generated using a GLFSR. diff --git a/gr-digital/include/digital/probe_density_b.h b/gr-digital/include/digital/probe_density_b.h index a81daf3f03..b0343d2cfb 100644 --- a/gr-digital/include/digital/probe_density_b.h +++ b/gr-digital/include/digital/probe_density_b.h @@ -28,9 +28,11 @@ namespace gr { namespace digital { /*! + * \ingroup measurement_tools_blk + * * This block maintains a running average of the input stream and - * makes it available as an accessor function. The input stream - * is type unsigned char. + * makes it available as an accessor function. The input stream is + * type unsigned char. * * If you send this block a stream of unpacked bytes, it will tell * you what the bit density is. diff --git a/gr-digital/include/digital/probe_mpsk_snr_est_c.h b/gr-digital/include/digital/probe_mpsk_snr_est_c.h index b58f1ab864..289940cdd1 100644 --- a/gr-digital/include/digital/probe_mpsk_snr_est_c.h +++ b/gr-digital/include/digital/probe_mpsk_snr_est_c.h @@ -30,20 +30,21 @@ namespace gr { namespace digital { - //! \brief A probe for computing SNR of a signal. - /*! \ingroup snr_blk + /*! + * \brief A probe for computing SNR of a signal. + * \ingroup measurement_tools_blk * - * This is a probe block (a sink) that can be used to monitor and - * retrieve estimations of the signal SNR. This probe is designed - * for use with M-PSK signals especially. The type of estimator - * is specified as the \p type parameter in the constructor. The - * estimators tend to trade off performance for accuracy, - * although experimentation should be done to figure out the - * right approach for a given implementation. Further, the - * current set of estimators are designed and proven - * theoretically under AWGN conditions; some amount of error - * should be assumed and/or estimated for real channel - * conditions. + * \details + * This is a probe block (a sink) that can be used to monitor and + * retrieve estimations of the signal SNR. This probe is designed + * for use with M-PSK signals especially. The type of estimator is + * specified as the \p type parameter in the constructor. The + * estimators tend to trade off performance for accuracy, although + * experimentation should be done to figure out the right approach + * for a given implementation. Further, the current set of + * estimators are designed and proven theoretically under AWGN + * conditions; some amount of error should be assumed and/or + * estimated for real channel conditions. */ class DIGITAL_API probe_mpsk_snr_est_c : virtual public gr_sync_block { @@ -55,12 +56,12 @@ namespace gr { * * Parameters: * - * \param type: the type of estimator to use \ref ref_snr_est_types - * "snr_est_type_t" for details about the available types. + * \param type: the type of estimator to use see + * gr::digital::snr_est_type_t for details about the types. * \param msg_nsamples: [not implemented yet] after this many - * samples, a message containing the SNR (key='snr') will be sent + * samples, a message containing the SNR (key='snr') will be sent * \param alpha: the update rate of internal running average - * calculations. + * calculations. */ static sptr make(snr_est_type_t type, int msg_nsamples=10000, diff --git a/gr-digital/include/digital/scrambler_bb.h b/gr-digital/include/digital/scrambler_bb.h index 95fce6dad7..6360662dae 100644 --- a/gr-digital/include/digital/scrambler_bb.h +++ b/gr-digital/include/digital/scrambler_bb.h @@ -33,6 +33,7 @@ namespace gr { * \brief Scramble an input stream using an LFSR. * \ingroup coding_blk * + * \details * This block works on the LSB only of the input data stream, * i.e., on an "unpacked binary" stream, and produces the same * format on its output. diff --git a/gr-digital/include/digital/simple_correlator.h b/gr-digital/include/digital/simple_correlator.h index b75dc24765..5cb7ddc6ee 100644 --- a/gr-digital/include/digital/simple_correlator.h +++ b/gr-digital/include/digital/simple_correlator.h @@ -31,7 +31,8 @@ namespace gr { /*! * \brief inverse of simple_framer (more or less) - * \ingroup sync_blk + * \ingroup packet_operators_blk + * \ingroup deprecated_blk */ class DIGITAL_API simple_correlator : virtual public gr_block { diff --git a/gr-digital/include/digital/simple_framer.h b/gr-digital/include/digital/simple_framer.h index 9e223081fb..951e13d8f2 100644 --- a/gr-digital/include/digital/simple_framer.h +++ b/gr-digital/include/digital/simple_framer.h @@ -31,8 +31,10 @@ namespace gr { /*! * \brief add sync field, seq number and command field to payload - * \ingroup sync_blk + * \ingroup packet_operators_blk + * \ingroup deprecated_blk * + * \details * Takes in enough samples to create a full output frame. The * frame is prepended with the GRSF_SYNC (defind in * simple_framer_sync.h) and an 8-bit sequence number. diff --git a/gr-digital/include/digital/simple_framer_sync.h b/gr-digital/include/digital/simple_framer_sync.h index 5dd2b82c3c..f6c8f148e6 100644 --- a/gr-digital/include/digital/simple_framer_sync.h +++ b/gr-digital/include/digital/simple_framer_sync.h @@ -27,9 +27,9 @@ namespace gr { namespace digital { /*! - * \brief Here are a couple of maximum length sequences - * (m-sequences) that were generated by the the "mseq" - * matlab/octave code downloaded from: <a + * Here are a couple of maximum length sequences (m-sequences) + * that were generated by the the "mseq" matlab/octave code + * downloaded from: <a * href="http://www.mathworks.com/matlabcentral/fileexchange/990">http://www.mathworks.com/matlabcentral/fileexchange/990</a> * * <pre> @@ -42,7 +42,6 @@ namespace gr { * 0xACDDA4E2F28C20FC (padded on right with a zero) * </pre> */ - static const unsigned long long GRSF_SYNC = 0xacdda4e2f28c20fcULL; static const int GRSF_BITS_PER_BYTE = 8; |