diff options
| author | Ben Reynwar <ben@reynwar.net> | 2012-08-14 07:12:53 -0700 |
|---|---|---|
| committer | Ben Reynwar <ben@reynwar.net> | 2012-08-14 07:22:43 -0700 |
| commit | 3e46aef392ba9b2e63bbfefefdb7178cc87049ab (patch) | |
| tree | 942e3a7a78344b638859b9f65ce37cacb070eb01 /gr-digital/python/ofdm_receiver.py | |
| parent | fe96ee8d82b2666951cf3cef8f7f5d991396273f (diff) | |
docs: Changed arguments in python docstrings to new formatting style.
Diffstat (limited to 'gr-digital/python/ofdm_receiver.py')
| -rw-r--r-- | gr-digital/python/ofdm_receiver.py | 19 |
1 files changed, 7 insertions, 12 deletions
diff --git a/gr-digital/python/ofdm_receiver.py b/gr-digital/python/ofdm_receiver.py index 9d4d6e559d..33d9b66268 100644 --- a/gr-digital/python/ofdm_receiver.py +++ b/gr-digital/python/ofdm_receiver.py @@ -47,18 +47,13 @@ class ofdm_receiver(gr.hier_block2): The input is the complex modulated signal at baseband. Synchronized packets are sent back to the demodulator. - @param fft_length: total number of subcarriers - @type fft_length: int - @param cp_length: length of cyclic prefix as specified in subcarriers (<= fft_length) - @type cp_length: int - @param occupied_tones: number of subcarriers used for data - @type occupied_tones: int - @param snr: estimated signal to noise ratio used to guide cyclic prefix synchronizer - @type snr: float - @param ks: known symbols used as preambles to each packet - @type ks: list of lists - @param logging: turn file logging on or off - @type logging: bool + Args: + fft_length: total number of subcarriers (int) + cp_length: length of cyclic prefix as specified in subcarriers (<= fft_length) (int) + occupied_tones: number of subcarriers used for data (int) + snr: estimated signal to noise ratio used to guide cyclic prefix synchronizer (float) + ks: known symbols used as preambles to each packet (list of lists) + logging: turn file logging on or off (bool) """ gr.hier_block2.__init__(self, "ofdm_receiver", |