diff options
| author | Ben Reynwar <ben@reynwar.net> | 2013-04-07 23:05:32 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2013-04-07 23:05:32 -0700 |
| commit | a770fd18b3d43bb8b7f13bfce0687884d61c0e74 (patch) | |
| tree | c68396ebee99a98805020d1cf4d1e07dfe6e8558 /gr-digital/include/digital | |
| parent | 87caee20b93f36c9c6c6f58bacfb218a21e9ada4 (diff) | |
digital: Minor documentation improvements.
Diffstat (limited to 'gr-digital/include/digital')
| -rw-r--r-- | gr-digital/include/digital/additive_scrambler_bb.h | 22 | ||||
| -rw-r--r-- | gr-digital/include/digital/descrambler_bb.h | 6 | ||||
| -rw-r--r-- | gr-digital/include/digital/kurtotic_equalizer_cc.h | 2 | ||||
| -rw-r--r-- | gr-digital/include/digital/mpsk_receiver_cc.h | 14 |
4 files changed, 20 insertions, 24 deletions
diff --git a/gr-digital/include/digital/additive_scrambler_bb.h b/gr-digital/include/digital/additive_scrambler_bb.h index c0ae70e7b1..bc4d4b36e9 100644 --- a/gr-digital/include/digital/additive_scrambler_bb.h +++ b/gr-digital/include/digital/additive_scrambler_bb.h @@ -32,10 +32,18 @@ namespace gr { /*! * \ingroup coding_blk * + * \brief + * Scramble an input stream using an LFSR. + * * \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. + * 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. + * + * The scrambler works by XORing the incoming bit stream by the + * output of the LFSR. Optionally, after 'count' bits have been + * processed, the shift register is reset to the seed value. + * This allows processing fixed length vectors of samples. */ class DIGITAL_API additive_scrambler_bb : virtual public gr_sync_block { @@ -46,19 +54,11 @@ namespace gr { /*! * \brief Create additive scrambler. * - * 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. - * * \param mask Polynomial mask for LFSR * \param seed Initial shift register contents * \param len Shift register length * \param count Number of bits after which shift register is reset, 0=never * - * The scrambler works by XORing the incoming bit stream by the - * output of the LFSR. Optionally, after 'count' bits have been - * processed, the shift register is reset to the seed value. - * This allows processing fixed length vectors of samples. */ static sptr make(int mask, int seed, int len, int count=0); diff --git a/gr-digital/include/digital/descrambler_bb.h b/gr-digital/include/digital/descrambler_bb.h index da8a3b0e88..9fa1d68425 100644 --- a/gr-digital/include/digital/descrambler_bb.h +++ b/gr-digital/include/digital/descrambler_bb.h @@ -45,10 +45,8 @@ namespace gr { typedef boost::shared_ptr<descrambler_bb> sptr; /*! - * 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. - * + * \brief Make a descrambler block. + * * \param mask Polynomial mask for LFSR * \param seed Initial shift register contents * \param len Shift register length diff --git a/gr-digital/include/digital/kurtotic_equalizer_cc.h b/gr-digital/include/digital/kurtotic_equalizer_cc.h index d32533b76e..be8c5f5cc2 100644 --- a/gr-digital/include/digital/kurtotic_equalizer_cc.h +++ b/gr-digital/include/digital/kurtotic_equalizer_cc.h @@ -34,7 +34,7 @@ namespace gr { * \ingroup equalizers_blk * * \details - * WARNING: This block does not yet work. + * Warning: This block does not yet work. * * "Y. Guo, J. Zhao, Y. Sun, "Sign kurtosis maximization based blind * equalization algorithm," IEEE Conf. on Control, Automation, diff --git a/gr-digital/include/digital/mpsk_receiver_cc.h b/gr-digital/include/digital/mpsk_receiver_cc.h index 9470cd8376..68874d178e 100644 --- a/gr-digital/include/digital/mpsk_receiver_cc.h +++ b/gr-digital/include/digital/mpsk_receiver_cc.h @@ -35,12 +35,10 @@ namespace gr { * \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 - * timing recovery. It works with (D)BPSK, (D)QPSK, and (D)8PSK - * as tested currently. It should also work for OQPSK and PI/4 - * DQPSK. + * It performs carrier frequency and phase locking as well as + * symbol timing recovery. It works with (D)BPSK, (D)QPSK, and + * (D)8PSK as tested currently. It should also work for OQPSK and + * PI/4 DQPSK. * * The phase and frequency synchronization are based on a Costas * loop that finds the error of the incoming signal point compared @@ -74,9 +72,9 @@ namespace gr { typedef boost::shared_ptr<mpsk_receiver_cc> sptr; /*! - * \brief Buil M-PSK receiver block. + * \brief Make a M-PSK receiver block. * - * \param M modulation order of the M-PSK modulation + * \param M modulation order of the M-PSK modulation * \param theta any constant phase rotation from the real axis of the constellation * \param loop_bw Loop bandwidth to set gains of phase/freq tracking loop * \param fmin minimum normalized frequency value the loop can achieve |