diff options
| author | eb <eb@221aa14e-8319-0410-a670-987f0aec2ac5> | 2009-05-22 21:22:22 +0000 |
|---|---|---|
| committer | eb <eb@221aa14e-8319-0410-a670-987f0aec2ac5> | 2009-05-22 21:22:22 +0000 |
| commit | 5a4b9ba9af590b2a269cb3e5872c85faa7c284d1 (patch) | |
| tree | 2049863d006e7bf3265d16975f8a784ef7ad1407 /gr-usrp | |
| parent | c6935bf1775ae73edf525376b79aeafc05f673b1 (diff) | |
Doc fixes.
git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11088 221aa14e-8319-0410-a670-987f0aec2ac5
Diffstat (limited to 'gr-usrp')
| -rw-r--r-- | gr-usrp/src/usrp_base.h | 4 | ||||
| -rw-r--r-- | gr-usrp/src/usrp_sink_base.h | 16 | ||||
| -rw-r--r-- | gr-usrp/src/usrp_source_base.h | 16 |
3 files changed, 18 insertions, 18 deletions
diff --git a/gr-usrp/src/usrp_base.h b/gr-usrp/src/usrp_base.h index c106739d01..a914159e61 100644 --- a/gr-usrp/src/usrp_base.h +++ b/gr-usrp/src/usrp_base.h @@ -152,14 +152,14 @@ public: /*! * \brief Set ADC offset correction - * \param which which ADC[0,3]: 0 = RX_A I, 1 = RX_A Q... + * \param which_adc which ADC[0,3]: 0 = RX_A I, 1 = RX_A Q... * \param offset 16-bit value to subtract from raw ADC input. */ bool set_adc_offset (int which_adc, int offset); /*! * \brief Set DAC offset correction - * \param which which DAC[0,3]: 0 = TX_A I, 1 = TX_A Q... + * \param which_dac which DAC[0,3]: 0 = TX_A I, 1 = TX_A Q... * \param offset 10-bit offset value (ambiguous format: See AD9862 datasheet). * \param offset_pin 1-bit value. If 0 offset applied to -ve differential pin; * If 1 offset applied to +ve differential pin. diff --git a/gr-usrp/src/usrp_sink_base.h b/gr-usrp/src/usrp_sink_base.h index 312bab2463..b27813a42a 100644 --- a/gr-usrp/src/usrp_sink_base.h +++ b/gr-usrp/src/usrp_sink_base.h @@ -55,13 +55,13 @@ class usrp_sink_base : public usrp_base { /*! * \brief convert between input item format and usrp native format * - * \param input_items[in] stream(s) of input items - * \param input_index[in] starting index in input_items - * \param input_items_available[in] number of items available starting at item[index] - * \param input_items_consumed[out] number of input items consumed by copy - * \param usrp_buffer[out] destination buffer - * \param usrp_buffer_length[in] \p usrp_buffer length in bytes - * \param bytes_written[out] number of bytes written into \p usrp_buffer + * \param[in] input_items stream(s) of input items + * \param[in] input_index starting index in input_items + * \param[in] input_items_available number of items available starting at item[index] + * \param[out] input_items_consumed number of input items consumed by copy + * \param[out] usrp_buffer destination buffer + * \param[in] usrp_buffer_length \p usrp_buffer length in bytes + * \param[out] bytes_written number of bytes written into \p usrp_buffer */ virtual void copy_to_usrp_buffer (gr_vector_const_void_star &input_items, int input_index, @@ -137,7 +137,7 @@ class usrp_sink_base : public usrp_base { * \param chan which DUC channel we're controlling (usually == which_side). * \param db the daughterboard we're controlling. * \param target_freq the RF frequency we want our baseband translated to. - * \param[out] tune_result details how the hardware was configured. + * \param[out] result details how the hardware was configured. * * \returns true iff everything was successful. */ diff --git a/gr-usrp/src/usrp_source_base.h b/gr-usrp/src/usrp_source_base.h index b9c4b9499b..e1d091d893 100644 --- a/gr-usrp/src/usrp_source_base.h +++ b/gr-usrp/src/usrp_source_base.h @@ -65,13 +65,13 @@ class usrp_source_base : public usrp_base { /*! * \brief convert between native usrp format and output item format * - * \param output_items[out] stream(s) of output items - * \param output_index[in] starting index in output_items - * \param output_items_available[in] number of empty items available at item[index] - * \param output_items_produced[out] number of items produced by copy - * \param usrp_buffer[in] source buffer - * \param usrp_buffer_length[in] number of bytes available in \p usrp_buffer - * \param bytes_read[out] number of bytes read from \p usrp_buffer + * \param[out] output_items stream(s) of output items + * \param[in] output_index starting index in output_items + * \param[in] output_items_available number of empty items available at item[index] + * \param[out] output_items_produced number of items produced by copy + * \param[in] usrp_buffer source buffer + * \param[in] usrp_buffer_length number of bytes available in \p usrp_buffer + * \param[out] bytes_read number of bytes read from \p usrp_buffer * * The copy must consume all bytes available. That is, \p bytes_read must equal * \p usrp_buffer_length. @@ -205,7 +205,7 @@ class usrp_source_base : public usrp_base { * \param chan which DDC channel we're controlling (almost always 0). * \param db the daughterboard we're controlling. * \param target_freq the RF frequency we want at DC in the complex baseband. - * \param[out] tune_result details how the hardware was configured. + * \param[out] result details how the hardware was configured. * * \returns true iff everything was successful. */ |