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.py | |
| parent | fe96ee8d82b2666951cf3cef8f7f5d991396273f (diff) | |
docs: Changed arguments in python docstrings to new formatting style.
Diffstat (limited to 'gr-digital/python/ofdm.py')
| -rw-r--r-- | gr-digital/python/ofdm.py | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/gr-digital/python/ofdm.py b/gr-digital/python/ofdm.py index 9f57920efc..4c53ad0108 100644 --- a/gr-digital/python/ofdm.py +++ b/gr-digital/python/ofdm.py @@ -46,10 +46,10 @@ class ofdm_mod(gr.hier_block2): Packets to be sent are enqueued by calling send_pkt. The output is the complex modulated signal at baseband. - @param options: pass modulation options from higher layers (fft length, occupied tones, etc.) - @param msgq_limit: maximum number of messages in message queue - @type msgq_limit: int - @param pad_for_usrp: If true, packets are padded such that they end up a multiple of 128 samples + Args: + options: pass modulation options from higher layers (fft length, occupied tones, etc.) + msgq_limit: maximum number of messages in message queue (int) + pad_for_usrp: If true, packets are padded such that they end up a multiple of 128 samples """ gr.hier_block2.__init__(self, "ofdm_mod", @@ -130,8 +130,8 @@ class ofdm_mod(gr.hier_block2): """ Send the payload. - @param payload: data to send - @type payload: string + Args: + payload: data to send (string) """ if eof: msg = gr.message(1) # tell self._pkt_input we're not sending any more packets @@ -188,9 +188,9 @@ class ofdm_demod(gr.hier_block2): The input is the complex modulated signal at baseband. Demodulated packets are sent to the handler. - @param options: pass modulation options from higher layers (fft length, occupied tones, etc.) - @param callback: function of two args: ok, payload - @type callback: ok: bool; payload: string + Args: + options: pass modulation options from higher layers (fft length, occupied tones, etc.) + callback: function of two args: ok, payload (ok: bool; payload: string) """ gr.hier_block2.__init__(self, "ofdm_demod", gr.io_signature(1, 1, gr.sizeof_gr_complex), # Input signature |