diff options
65 files changed, 150 insertions, 111 deletions
diff --git a/docs/doxygen/other/group_defs.dox b/docs/doxygen/other/group_defs.dox index 44f436393..6f2e1ac7f 100644 --- a/docs/doxygen/other/group_defs.dox +++ b/docs/doxygen/other/group_defs.dox @@ -16,12 +16,14 @@ /*! \defgroup modulation_blk Signal Modulation */ /*! \defgroup demodulation_blk Signal Demodulation */ /*! \defgroup coding_blk Information Coding and Decoding*/ -/*! \defgroup synch_blk Synchronization */ +/*! \defgroup sync_blk Synchronization */ /*! \defgroup eq_blk Equalization */ /*! \defgroup converter_blk Type Conversions */ /*! \defgroup level_blk Signal Level Control (AGC) */ /*! \defgroup dft_blk Fourier Transform */ /*! \defgroup wavelet_blk Wavelet Transform */ +/*! \defgroup ofdm_blk OFDM Blocks */ +/*! \defgroup pager_blk Pager Blocks */ /*! \defgroup misc_blk Miscellaneous Blocks */ /*! \defgroup slicedice_blk Slicing and Dicing Streams */ /*! \defgroup vocoder_blk Voice Encoders and Decoders */ @@ -59,13 +61,17 @@ * Pager Applications */ -/*! - * \defgroup sounder Sounder - * Channel Sounder - */ - /*! @} */ /*! \defgroup usrp USRP */ /*! \defgroup usrp2 USRP2 */ + +/*! + * \defgroup gcell gcell: Cell Broadband Engine SPE Scheduler & RPC Mechanism + * + * For additional information please see the + * <a href="http://gnuradio.org/trac/wiki/Gcell">gcell wiki page</a> + * and <a href="http://comsec.com/papers/gcell-sdrf-2008.pdf">gcell-sdrf-2008.pdf</a>. + */ + /*! \defgroup hardware Misc Hardware Control */ diff --git a/docs/doxygen/other/main_page.dox b/docs/doxygen/other/main_page.dox index 5c37905fa..43fcbf67a 100644 --- a/docs/doxygen/other/main_page.dox +++ b/docs/doxygen/other/main_page.dox @@ -2,4 +2,11 @@ Welcome to GNU Radio! +For a list of all GNU Radio C++ blocks, please see <a href="modules.html">C++ Blocks</a>. + +Please note that at this time, we haven't found an acceptable way to +provide unified documentation for the C++ parts of the system and the +parts written in Python (mostly hierarchical blocks). Until this gets +worked out, please bear with us, or better yet, solve it for us! + */ diff --git a/gcell/include/gcell/gc_job_desc.h b/gcell/include/gcell/gc_job_desc.h index 5ff99e2e2..7dc9d182c 100644 --- a/gcell/include/gcell/gc_job_desc.h +++ b/gcell/include/gcell/gc_job_desc.h @@ -171,6 +171,7 @@ typedef struct gc_job_ea_args { /*! * \brief "job description" that is DMA'd to/from the SPE. + * \ingroup gcell */ typedef struct gc_job_desc { diff --git a/gcell/include/gcell/gc_job_manager.h b/gcell/include/gcell/gc_job_manager.h index 67abce7ed..8e5de5217 100644 --- a/gcell/include/gcell/gc_job_manager.h +++ b/gcell/include/gcell/gc_job_manager.h @@ -149,6 +149,7 @@ gc_make_job_manager(const gc_jm_options *options = 0); /*! * \brief Abstract class that manages SPE jobs. + * \ingroup gcell * * There is typically a single instance derived from this class. * It is safe to call its methods from any thread. @@ -211,10 +212,10 @@ public: /*! * \brief wait for 1 or more jobs to complete. * - * \param[input] njobs is the length of arrays \p jd and \p done. - * \param[input] jd are the jobs that are to be waited for. - * \param[output] done indicates whether the corresponding job is complete. - * \param[input] mode indicates whether to wait for ALL or ANY of the jobs + * \param[in] njobs is the length of arrays \p jd and \p done. + * \param[in] jd are the jobs that are to be waited for. + * \param[out] done indicates whether the corresponding job is complete. + * \param[in] mode indicates whether to wait for ALL or ANY of the jobs * in \p jd to complete. * * A thread may only wait for jobs which it submitted. diff --git a/gcell/lib/runtime/gc_job_manager_impl.h b/gcell/lib/runtime/gc_job_manager_impl.h index 07dcabaf2..a56117870 100644 --- a/gcell/lib/runtime/gc_job_manager_impl.h +++ b/gcell/lib/runtime/gc_job_manager_impl.h @@ -248,10 +248,10 @@ public: /*! * \brief wait for 1 or more jobs to complete. * - * \param[input] njobs is the length of arrays \p jd and \p done. - * \param[input] jd are the jobs that are to be waited for. - * \param[output] done indicates whether the corresponding job is complete. - * \param[input] mode indicates whether to wait for ALL or ANY of the jobs + * \param[in] njobs is the length of arrays \p jd and \p done. + * \param[in] jd are the jobs that are to be waited for. + * \param[out] done indicates whether the corresponding job is complete. + * \param[in] mode indicates whether to wait for ALL or ANY of the jobs * in \p jd to complete. * * A thread may only wait for jobs which it submitted. diff --git a/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h b/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h index 42ef62084..78fdf73c0 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h +++ b/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h @@ -27,7 +27,7 @@ /*! * \brief 3DNow! version of gr_fir_fsf - * \ingroup filter_blk + * \ingroup filter_primitive */ class gr_fir_fsf_3dnow : public gr_fir_fsf_simd { @@ -38,7 +38,7 @@ public: /*! * \brief SSE version of gr_fir_fsf - * \ingroup filter_blk + * \ingroup filter_primitive */ class gr_fir_fsf_sse : public gr_fir_fsf_simd { diff --git a/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h b/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h index 8ecdb6a20..2af45c8f4 100644 --- a/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h +++ b/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h @@ -27,12 +27,11 @@ /*! * \brief common base class for SIMD versions of gr_fir_scc - * \ingroup filter_blk + * \ingroup filter_primitive * * This base class handles alignment issues common to SSE and 3DNOW * subclasses. */ - class gr_fir_scc_simd : public gr_fir_scc_generic { protected: diff --git a/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h b/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h index d7af64d3f..04227a145 100644 --- a/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h +++ b/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h @@ -39,7 +39,7 @@ gr_make_clock_recovery_mm_cc (float omega, float gain_omega, float mu, float gai /*! * \brief Mueller and Müller (M&M) based clock recovery block with complex input, complex output. - * \ingroup synch_blk + * \ingroup sync_blk * * This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer. * The complex version here is based on: diff --git a/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h b/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h index 89833d343..d2ec6d3e6 100644 --- a/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h +++ b/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h @@ -39,7 +39,7 @@ gr_make_clock_recovery_mm_ff (float omega, float gain_omega, float mu, float gai /*! * \brief Mueller and Müller (M&M) based clock recovery block with float input, float output. - * \ingroup synch_blk + * \ingroup sync_blk * * This implements the Mueller and Müller (M&M) discrete-time error-tracking synchronizer. * diff --git a/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h b/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h index 622eee75d..581713c14 100644 --- a/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h +++ b/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h @@ -38,7 +38,7 @@ gr_make_correlate_access_code_bb (const std::string &access_code, int threshold) /*! * \brief Examine input for specified access code, one bit at a time. - * \ingroup synch_blk + * \ingroup sync_blk * * 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/gnuradio-core/src/lib/general/gr_costas_loop_cc.h b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h index c034cd1f1..3b4aab86c 100644 --- a/gnuradio-core/src/lib/general/gr_costas_loop_cc.h +++ b/gnuradio-core/src/lib/general/gr_costas_loop_cc.h @@ -30,7 +30,7 @@ /*! \brief A Costas loop carrier recovery module. - * \ingroup synch_blk + * \ingroup sync_blk * * The Costas loop locks to the center frequency of a signal and * downconverts it to baseband. The second (order=2) order loop is @@ -66,7 +66,7 @@ gr_make_costas_loop_cc (float alpha, float beta, /*! * \brief Carrier tracking PLL for QPSK - * \ingroup synch_blk + * \ingroup sync_blk * input: complex; output: complex * <br>The Costas loop can have two output streams: * stream 1 is the baseband I and Q; @@ -96,7 +96,7 @@ class gr_costas_loop_cc : public gr_sync_block float phase_detector_4(gr_complex sample) const; // for QPSK /*! \brief the phase detector circuit for second-order loops - * \param a complex sample + * \param sample a complex sample * \return the phase error */ float phase_detector_2(gr_complex sample) const; // for BPSK diff --git a/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h b/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h index 9bd1d9e5a..4ffcd3771 100644 --- a/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h +++ b/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h @@ -37,7 +37,7 @@ gr_make_dd_mpsk_sync_cc (float alpha, float beta, /*! * \brief Decision directed M-PSK synchronous demod - * \ingroup synch_blk + * \ingroup sync_blk * This block performs joint carrier tracking and symbol timing recovery. * * input: complex baseband; output: properly timed complex samples ready for slicing. diff --git a/gnuradio-core/src/lib/general/gr_descrambler_bb.h b/gnuradio-core/src/lib/general/gr_descrambler_bb.h index 9e66ceff2..19787690c 100644 --- a/gnuradio-core/src/lib/general/gr_descrambler_bb.h +++ b/gnuradio-core/src/lib/general/gr_descrambler_bb.h @@ -39,7 +39,7 @@ gr_descrambler_bb_sptr gr_make_descrambler_bb(int mask, int seed, int len); * \param seed Initial shift register contents * \param len Shift register length * - * \ingroup misc + * \ingroup coding_blk */ class gr_descrambler_bb : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h b/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h index 5c3b253af..024d74ada 100644 --- a/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h +++ b/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h @@ -43,7 +43,8 @@ gr_make_mpsk_receiver_cc (unsigned int M, float theta, /*! * \brief This block takes care of receiving M-PSK modulated signals through phase, frequency, and symbol * synchronization. - * \ingroup synch_blk + * \ingroup sync_blk + * \ingroup demod_blk * * 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. diff --git a/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h b/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h index c4244f828..12ae6a8f6 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h @@ -37,9 +37,8 @@ gr_make_ofdm_bpsk_demapper (unsigned int occupied_carriers); /*! * \brief take a vector of complex constellation points in from an FFT * and demodulate to a stream of bits. Simple BPSK version. - * \ingroup demodulation_blk + * \ingroup ofdm_blk */ - class gr_ofdm_bpsk_demapper : public gr_block { friend gr_ofdm_bpsk_demapper_sptr diff --git a/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h b/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h index 6b6dc5784..eab91cd11 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h @@ -36,7 +36,7 @@ gr_make_ofdm_cyclic_prefixer (size_t input_size, size_t output_size); /*! * \brief adds a cyclic prefix vector to an input size long ofdm * symbol(vector) and converts vector to a stream output_size long. - * \ingroup synch_blk + * \ingroup ofdm_blk */ class gr_ofdm_cyclic_prefixer : public gr_sync_interpolator { diff --git a/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h b/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h index 22dea54bc..979e1996b 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h @@ -37,8 +37,8 @@ gr_make_ofdm_demapper_vcb (unsigned int bits_per_symbol, unsigned int vlen); * bits. Abstract class must be subclassed with specific mapping. * * \ingroup demodulation_blk + * \ingroup ofdm_blk */ - class gr_ofdm_demapper_vcb : public gr_sync_decimator { friend gr_ofdm_demapper_vcb_sptr diff --git a/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h b/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h index 38fec9263..5db8dbb7f 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h @@ -40,6 +40,7 @@ gr_make_ofdm_frame_acquisition (unsigned int occupied_carriers, unsigned int fft * \brief take a vector of complex constellation points in from an FFT * and performs a correlation and equalization. * \ingroup demodulation_blk + * \ingroup ofdm_blk * * 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 @@ -59,12 +60,9 @@ class gr_ofdm_frame_acquisition : public gr_block * \brief Build an OFDM correlator and equalizer. * \param occupied_carriers The number of subcarriers with data in the received symbol * \param fft_length The size of the FFT vector (occupied_carriers + unused carriers) - * \param known_symbol1 A vector of complex numbers representing a known symbol at the + * \param cplen The length of the cycle prefix + * \param known_symbol A vector of complex numbers representing a known symbol at the * start of a frame (usually a BPSK PN sequence) - * \param known_symbol2 A vector of complex numbers representing a known symbol at the - * start of a frame after known_symbol1 (usually a BPSK PN sequence). - * Both of these start symbols are differentially correlated to compensate - * for phase changes between symbols. * \param max_fft_shift_len Set's the maximum distance you can look between bins for correlation */ friend gr_ofdm_frame_acquisition_sptr diff --git a/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h b/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h index 729806dae..c419b8673 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h @@ -39,6 +39,8 @@ gr_make_ofdm_frame_sink (const std::vector<gr_complex> &sym_position, * \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 + * * 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 given modulation type. diff --git a/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h b/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h index 2d1007c25..57c1af013 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h @@ -34,7 +34,8 @@ gr_make_ofdm_insert_preamble(int fft_length, /*! * \brief insert "pre-modulated" preamble symbols before each payload. - * \ingroup synch_blk + * \ingroup sync_blk + * \ingroup ofdm_blk * * <pre> * input 1: stream of vectors of gr_complex [fft_length] diff --git a/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h b/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h index b75d9ee3b..5a21b90af 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h @@ -39,7 +39,7 @@ gr_make_ofdm_mapper_bcv (const std::vector<gr_complex> &constellation, unsigned * constellation points suitable for IFFT input to be used in an ofdm * modulator. Abstract class must be subclassed with specific mapping. * \ingroup modulation_blk - * + * \ingroup ofdm_blk */ class gr_ofdm_mapper_bcv : public gr_sync_block diff --git a/gnuradio-core/src/lib/general/gr_ofdm_sampler.h b/gnuradio-core/src/lib/general/gr_ofdm_sampler.h index 916b11cf4..d059636ed 100644 --- a/gnuradio-core/src/lib/general/gr_ofdm_sampler.h +++ b/gnuradio-core/src/lib/general/gr_ofdm_sampler.h @@ -34,9 +34,8 @@ gr_ofdm_sampler_sptr gr_make_ofdm_sampler (unsigned int fft_length, /*! * \brief does the rest of the OFDM stuff - * \ingroup misc + * \ingroup ofdm_blk */ - class gr_ofdm_sampler : public gr_block { friend gr_ofdm_sampler_sptr gr_make_ofdm_sampler (unsigned int fft_length, diff --git a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h index f3a93741f..195f06016 100644 --- a/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h +++ b/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h @@ -33,7 +33,7 @@ gr_pll_carriertracking_cc_sptr gr_make_pll_carriertracking_cc (float alpha, floa /*! * \brief Implements a PLL which locks to the input frequency and outputs the * input signal mixed with that carrier. - * \ingroup synch_blk + * \ingroup sync_blk * * input: stream of complex; output: stream of complex * diff --git a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h index bc462780f..0581c8724 100644 --- a/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h +++ b/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h @@ -33,7 +33,7 @@ gr_pll_freqdet_cf_sptr gr_make_pll_freqdet_cf (float alpha, float beta, /*! * \brief Implements a PLL which locks to the input frequency and outputs * an estimate of that frequency. Useful for FM Demod. - * \ingroup synch_blk + * \ingroup sync_blk * * input: stream of complex; output: stream of floats * diff --git a/gnuradio-core/src/lib/general/gr_pll_refout_cc.h b/gnuradio-core/src/lib/general/gr_pll_refout_cc.h index 9c91b87f3..3263c957f 100644 --- a/gnuradio-core/src/lib/general/gr_pll_refout_cc.h +++ b/gnuradio-core/src/lib/general/gr_pll_refout_cc.h @@ -34,7 +34,7 @@ gr_pll_refout_cc_sptr gr_make_pll_refout_cc (float alpha, float beta, float max_freq, float min_freq); /*! * \brief Implements a PLL which locks to the input frequency and outputs a carrier - * \ingroup synch_blk + * \ingroup sync_blk * * input: stream of complex; output: stream of complex * diff --git a/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h b/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h index 933aff02b..73bb7aa8c 100644 --- a/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h +++ b/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h @@ -34,7 +34,7 @@ gr_make_pn_correlator_cc(int degree, int mask=0, int seed=1); /*! * \brief PN code sequential search correlator * - * \ingroup synch_blk + * \ingroup sync_blk * Receives complex baseband signal, outputs complex correlation against * reference PN code, one sample per PN code period */ diff --git a/gnuradio-core/src/lib/general/gr_simple_correlator.h b/gnuradio-core/src/lib/general/gr_simple_correlator.h index 319d9427f..b21d38a04 100644 --- a/gnuradio-core/src/lib/general/gr_simple_correlator.h +++ b/gnuradio-core/src/lib/general/gr_simple_correlator.h @@ -35,7 +35,7 @@ gr_simple_correlator_sptr gr_make_simple_correlator (int payload_bytesize); /*! * \brief inverse of gr_simple_framer (more or less) - * \ingroup synch_blk + * \ingroup sync_blk */ class gr_simple_correlator : public gr_block { diff --git a/gnuradio-core/src/lib/general/gr_simple_framer.h b/gnuradio-core/src/lib/general/gr_simple_framer.h index de38fd9ba..d930da33b 100644 --- a/gnuradio-core/src/lib/general/gr_simple_framer.h +++ b/gnuradio-core/src/lib/general/gr_simple_framer.h @@ -32,7 +32,7 @@ gr_simple_framer_sptr gr_make_simple_framer (int payload_bytesize); /*! * \brief add sync field, seq number and command field to payload - * \ingroup synch_blk + * \ingroup sync_blk */ class gr_simple_framer : public gr_block { diff --git a/gnuradio-core/src/lib/general/gr_simple_framer_sync.h b/gnuradio-core/src/lib/general/gr_simple_framer_sync.h index eaf3ef635..d5712fe8e 100644 --- a/gnuradio-core/src/lib/general/gr_simple_framer_sync.h +++ b/gnuradio-core/src/lib/general/gr_simple_framer_sync.h @@ -28,7 +28,7 @@ * the "mseq" matlab/octave code downloaded from: * http://www.mathworks.com/matlabcentral/fileexchange/loadFile.do?objectId=990&objectType=file * - * \ingroup synch_blk + * <pre> * 31-bit m-sequence: * 0110100100001010111011000111110 * 0x690AEC76 (padded on right with a zero) @@ -36,6 +36,7 @@ * 63-bit m-sequence: * 101011001101110110100100111000101111001010001100001000001111110 * 0xACDDA4E2F28C20FC (padded on right with a zero) + * </pre> */ static const unsigned long long GRSF_SYNC = 0xacdda4e2f28c20fcULL; diff --git a/gnuradio-core/src/lib/general/gri_fft.h b/gnuradio-core/src/lib/general/gri_fft.h index 21d6ffdaf..9ffcc5a50 100644 --- a/gnuradio-core/src/lib/general/gri_fft.h +++ b/gnuradio-core/src/lib/general/gri_fft.h @@ -75,7 +75,7 @@ public: /*! * \brief FFT: real in, complex out - * \ingroup dft_blk + * \ingroup misc */ class gri_fft_real_fwd { int d_fft_size; @@ -106,7 +106,7 @@ public: /*! * \brief FFT: complex in, float out - * \ingroup dft_blk + * \ingroup misc */ class gri_fft_real_rev { int d_fft_size; diff --git a/gnuradio-core/src/lib/hier/gr_channel_model.h b/gnuradio-core/src/lib/hier/gr_channel_model.h index 42f0ecc69..116b5dc14 100644 --- a/gnuradio-core/src/lib/hier/gr_channel_model.h +++ b/gnuradio-core/src/lib/hier/gr_channel_model.h @@ -37,6 +37,10 @@ gr_channel_model_sptr gr_make_channel_model(double noise_voltage=0.0, const std::vector<gr_complex> &taps=std::vector<gr_complex>(1, 1), double noise_seed=3021); +/*! + * \brief channel simulator + * \ingroup misc_blk + */ class gr_channel_model : public gr_hier_block2 { private: diff --git a/gnuradio-core/src/lib/runtime/gr_buffer.h b/gnuradio-core/src/lib/runtime/gr_buffer.h index 75063cc6a..cb593eea3 100644 --- a/gnuradio-core/src/lib/runtime/gr_buffer.h +++ b/gnuradio-core/src/lib/runtime/gr_buffer.h @@ -163,7 +163,8 @@ class gr_buffer { }; /*! - * \brief create a new gr_buffer_reader and attach it to buffer \p buf + * \brief Create a new gr_buffer_reader and attach it to buffer \p buf + * \param buf is the buffer the \p gr_buffer_reader reads from. * \param nzero_preload -- number of zero items to "preload" into buffer. * \param link is the block that reads from the buffer using this gr_buffer_reader. */ diff --git a/gnuradio-core/src/lib/runtime/gr_hier_block2.h b/gnuradio-core/src/lib/runtime/gr_hier_block2.h index f0bbe4e65..f50b1cb94 100644 --- a/gnuradio-core/src/lib/runtime/gr_hier_block2.h +++ b/gnuradio-core/src/lib/runtime/gr_hier_block2.h @@ -35,7 +35,7 @@ gr_hier_block2_sptr gr_make_hier_block2(const std::string &name, class gr_hier_block2_detail; /*! - * \brief gr_hier_block2 - Hierarchical container class for gr_block's + * \brief Hierarchical container class for gr_block's and gr_hier_block2's * \ingroup container_blk * \ingroup base_blk * diff --git a/gnuradio-core/src/lib/runtime/gr_io_signature.h b/gnuradio-core/src/lib/runtime/gr_io_signature.h index 8c327259c..5d194cf55 100644 --- a/gnuradio-core/src/lib/runtime/gr_io_signature.h +++ b/gnuradio-core/src/lib/runtime/gr_io_signature.h @@ -98,7 +98,7 @@ class gr_io_signature { friend gr_io_signature_sptr gr_make_io_signaturev(int min_streams, int max_streams, - const std::vector<int> &sizeof_stream_item); + const std::vector<int> &sizeof_stream_items); public: diff --git a/gr-audio-alsa/src/audio_alsa_sink.h b/gr-audio-alsa/src/audio_alsa_sink.h index f2aa80aea..d4b540382 100644 --- a/gr-audio-alsa/src/audio_alsa_sink.h +++ b/gr-audio-alsa/src/audio_alsa_sink.h @@ -40,12 +40,12 @@ typedef boost::shared_ptr<audio_alsa_sink> audio_alsa_sink_sptr; * \brief make an alsa audio sink. * * \param sampling_rate sampling rate in Hz - * \param dev ALSA pcm device name, e.g., "hw:0,0" + * \param device_name ALSA pcm device name, e.g., "hw:0,0" * \param ok_to_block (currently ignored) */ audio_alsa_sink_sptr audio_alsa_make_sink (int sampling_rate, - const std::string dev = "", + const std::string device_name = "", bool ok_to_block = true); /*! diff --git a/gr-audio-alsa/src/audio_alsa_source.h b/gr-audio-alsa/src/audio_alsa_source.h index cbda10f68..db6c45683 100644 --- a/gr-audio-alsa/src/audio_alsa_source.h +++ b/gr-audio-alsa/src/audio_alsa_source.h @@ -39,12 +39,12 @@ typedef boost::shared_ptr<audio_alsa_source> audio_alsa_source_sptr; * \brief Make an ALSA audio source. * * \param sampling_rate sampling rate - * \param dev ALSA pcm device name, e.g., "hw:0,0" + * \param device_name ALSA pcm device name, e.g., "hw:0,0" * \param ok_to_block (currently ignored) */ audio_alsa_source_sptr audio_alsa_make_source (int sampling_rate, - const std::string dev = "", + const std::string device_name = "", bool ok_to_block = true); /*! diff --git a/gr-audio-jack/src/audio_jack_sink.h b/gr-audio-jack/src/audio_jack_sink.h index 78b93486d..ac74cfc37 100644 --- a/gr-audio-jack/src/audio_jack_sink.h +++ b/gr-audio-jack/src/audio_jack_sink.h @@ -35,12 +35,12 @@ typedef boost::shared_ptr<audio_jack_sink> audio_jack_sink_sptr; * \brief make an JACK audio sink. * * \param sampling_rate sampling rate in Hz - * \param dev JACK device name, e.g., "gr_sink" + * \param device_name JACK device name, e.g., "gr_sink" * \param ok_to_block */ audio_jack_sink_sptr audio_jack_make_sink (int sampling_rate, - const std::string dev = "", + const std::string device_name = "", bool ok_to_block = true); int jack_sink_process (jack_nframes_t nframes, void *arg); diff --git a/gr-audio-jack/src/audio_jack_source.h b/gr-audio-jack/src/audio_jack_source.h index aa2821988..8831a7363 100644 --- a/gr-audio-jack/src/audio_jack_source.h +++ b/gr-audio-jack/src/audio_jack_source.h @@ -35,12 +35,12 @@ typedef boost::shared_ptr<audio_jack_source> audio_jack_source_sptr; * \brief make a JACK audio source. * * \param sampling_rate sampling rate in Hz - * \param dev JACK device name, e.g., "gr_source" + * \param device_name JACK device name, e.g., "gr_source" * \param ok_to_block */ audio_jack_source_sptr audio_jack_make_source (int sampling_rate, - const std::string dev = "", + const std::string device_name = "", bool ok_to_block = true); int jack_source_process (jack_nframes_t nframes, void *arg); diff --git a/gr-audio-portaudio/src/audio_portaudio_sink.h b/gr-audio-portaudio/src/audio_portaudio_sink.h index a0155367d..0e082c5e2 100644 --- a/gr-audio-portaudio/src/audio_portaudio_sink.h +++ b/gr-audio-portaudio/src/audio_portaudio_sink.h @@ -37,12 +37,12 @@ typedef boost::shared_ptr<audio_portaudio_sink> audio_portaudio_sink_sptr; * \brief PORTAUDIO audio sink. * * \param sampling_rate sampling rate in Hz - * \param dev PORTAUDIO device name, e.g., "pa:" + * \param device_name PORTAUDIO device name, e.g., "pa:" * \param ok_to_block true if it's ok for us to block */ audio_portaudio_sink_sptr audio_portaudio_make_sink (int sampling_rate, - const std::string dev = "", + const std::string device_name = "", bool ok_to_block = true); PaStreamCallback portaudio_sink_callback; diff --git a/gr-audio-portaudio/src/audio_portaudio_source.h b/gr-audio-portaudio/src/audio_portaudio_source.h index cea631c70..d14fe8058 100644 --- a/gr-audio-portaudio/src/audio_portaudio_source.h +++ b/gr-audio-portaudio/src/audio_portaudio_source.h @@ -37,12 +37,12 @@ typedef boost::shared_ptr<audio_portaudio_source> audio_portaudio_source_sptr; * \brief PORTAUDIO audio source. * * \param sampling_rate sampling rate in Hz - * \param dev PORTAUDIO device name, e.g., "pa:" + * \param device_name PORTAUDIO device name, e.g., "pa:" * \param ok_to_block true if it's ok for us to block */ audio_portaudio_source_sptr audio_portaudio_make_source (int sampling_rate, - const std::string dev = "", + const std::string device_name = "", bool ok_to_block = true); PaStreamCallback portaudio_source_callback; diff --git a/gr-comedi/src/comedi_sink_s.h b/gr-comedi/src/comedi_sink_s.h index 41ddea361..22f0428d4 100644 --- a/gr-comedi/src/comedi_sink_s.h +++ b/gr-comedi/src/comedi_sink_s.h @@ -49,7 +49,7 @@ comedi_make_sink_s (int sampling_freq, */ class comedi_sink_s : public gr_sync_block { friend comedi_sink_s_sptr - comedi_make_sink_s (int sampling_freq, const std::string device_name); + comedi_make_sink_s (int sampling_freq, const std::string dev); // typedef for pointer to class work method typedef int (comedi_sink_s::*work_t)(int noutput_items, diff --git a/gr-comedi/src/comedi_source_s.h b/gr-comedi/src/comedi_source_s.h index a4809d1f1..c406f274b 100644 --- a/gr-comedi/src/comedi_source_s.h +++ b/gr-comedi/src/comedi_source_s.h @@ -49,7 +49,7 @@ comedi_make_source_s (int sampling_freq, */ class comedi_source_s : public gr_sync_block { friend comedi_source_s_sptr - comedi_make_source_s (int sampling_freq, const std::string device_name); + comedi_make_source_s (int sampling_freq, const std::string dev); // typedef for pointer to class work method typedef int (comedi_source_s::*work_t)(int noutput_items, diff --git a/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h b/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h index 5113c80cf..f7b50909f 100644 --- a/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h +++ b/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h @@ -57,7 +57,7 @@ cvsd_decode_bs_sptr cvsd_make_decode_bs (short min_step=10, * is modeled after the CVSD encoder/decoder specifications defined in the * Bluetooth standard. * - * \ingroup vocoder + * \ingroup vocoder_blk * * CVSD is a method for encoding speech that seeks to reduce the * bandwidth required for digital voice transmission. CVSD takes diff --git a/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h b/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h index f421f14cf..a7994d4ed 100644 --- a/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h +++ b/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h @@ -58,7 +58,7 @@ cvsd_encode_sb_sptr cvsd_make_encode_sb (short min_step=10, * is modeled after the CVSD encoder/decoder specifications defined in the * Bluetooth standard. * - * \ingroup vocoder + * \ingroup vocoder_blk * * CVSD is a method for encoding speech that seeks to reduce the * bandwidth required for digital voice transmission. CVSD takes diff --git a/gr-gcell/src/gcell_fft_vcc.h b/gr-gcell/src/gcell_fft_vcc.h index ee4192557..9e3035b44 100644 --- a/gr-gcell/src/gcell_fft_vcc.h +++ b/gr-gcell/src/gcell_fft_vcc.h @@ -36,6 +36,7 @@ gcell_make_fft_vcc(int fft_size, bool forward, const std::vector<float> &window, /*! * \brief Compute forward or reverse FFT. complex vector in / complex vector out. * \ingroup dft_blk + * \ingroup gcell * * Concrete class that uses gcell to offload FFT to SPEs. */ diff --git a/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h b/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h index 17815ac5d..8002c2ce3 100644 --- a/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h +++ b/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h @@ -31,7 +31,7 @@ gsm_fr_decode_ps_sptr gsm_fr_make_decode_ps (); /*! * \brief GSM 06.10 Full Rate Vocoder Decoder - * \ingroup vocoder + * \ingroup vocoder_blk */ class gsm_fr_decode_ps : public gr_sync_interpolator { struct gsm_state *d_gsm; diff --git a/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h b/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h index 0031499c3..f158a3d02 100644 --- a/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h +++ b/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h @@ -31,7 +31,7 @@ gsm_fr_encode_sp_sptr gsm_fr_make_encode_sp (); /*! * \brief GSM 06.10 Full Rate Vocoder Encoder - * \ingroup vocoder + * \ingroup vocoder_blk * * shorts in; 33 byte packets out */ diff --git a/gr-pager/src/pager_flex_deinterleave.h b/gr-pager/src/pager_flex_deinterleave.h index 030d0bff0..7211a71ad 100644 --- a/gr-pager/src/pager_flex_deinterleave.h +++ b/gr-pager/src/pager_flex_deinterleave.h @@ -31,7 +31,7 @@ pager_flex_deinterleave_sptr pager_make_flex_deinterleave(); /*! * \brief flex deinterleave description - * \ingroup block + * \ingroup pager_blk */ class pager_flex_deinterleave : public gr_sync_decimator diff --git a/gr-pager/src/pager_flex_parse.h b/gr-pager/src/pager_flex_parse.h index 692a588a6..0f7cfb370 100644 --- a/gr-pager/src/pager_flex_parse.h +++ b/gr-pager/src/pager_flex_parse.h @@ -32,13 +32,12 @@ typedef boost::shared_ptr<pager_flex_parse> pager_flex_parse_sptr; pager_flex_parse_sptr pager_make_flex_parse(gr_msg_queue_sptr queue, float freq); +#define FIELD_DELIM ((unsigned char)128) + /*! * \brief flex parse description - * \ingroup block + * \ingroup pager_blk */ - -#define FIELD_DELIM ((unsigned char)128) - class pager_flex_parse : public gr_sync_block { private: diff --git a/gr-pager/src/pager_flex_sync.h b/gr-pager/src/pager_flex_sync.h index f23221db8..b401bf532 100644 --- a/gr-pager/src/pager_flex_sync.h +++ b/gr-pager/src/pager_flex_sync.h @@ -32,7 +32,7 @@ pager_flex_sync_sptr pager_make_flex_sync(); /*! * \brief flex sync description - * \ingroup block + * \ingroup pager_blk */ class pager_flex_sync : public gr_block diff --git a/gr-pager/src/pager_slicer_fb.h b/gr-pager/src/pager_slicer_fb.h index f157b11d7..75eea3cd3 100644 --- a/gr-pager/src/pager_slicer_fb.h +++ b/gr-pager/src/pager_slicer_fb.h @@ -31,7 +31,7 @@ pager_slicer_fb_sptr pager_make_slicer_fb(float alpha); /*! * \brief slicer description - * \ingroup block + * \ingroup pager_blk */ class pager_slicer_fb : public gr_sync_block { diff --git a/gr-trellis/src/lib/trellis_encoder_XX.h.t b/gr-trellis/src/lib/trellis_encoder_XX.h.t index 3b49a13c1..b56fde0bf 100644 --- a/gr-trellis/src/lib/trellis_encoder_XX.h.t +++ b/gr-trellis/src/lib/trellis_encoder_XX.h.t @@ -35,9 +35,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief Convolutional encoder. - * \ingroup block - * - * + * \ingroup coding_blk */ class @NAME@ : public gr_sync_block { diff --git a/gr-trellis/src/lib/trellis_metrics_X.h.t b/gr-trellis/src/lib/trellis_metrics_X.h.t index c46740a54..f862a032d 100644 --- a/gr-trellis/src/lib/trellis_metrics_X.h.t +++ b/gr-trellis/src/lib/trellis_metrics_X.h.t @@ -35,8 +35,7 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; /*! * \brief Evaluate metrics for use by the Viterbi algorithm. - * \ingroup block - * + * \ingroup coding_blk */ class @NAME@ : public gr_block { diff --git a/gr-trellis/src/lib/trellis_permutation.h b/gr-trellis/src/lib/trellis_permutation.h index 2f52c2a9e..5505caf89 100644 --- a/gr-trellis/src/lib/trellis_permutation.h +++ b/gr-trellis/src/lib/trellis_permutation.h @@ -34,9 +34,7 @@ trellis_permutation_sptr trellis_make_permutation (int K, const std::vector<int> /*! * \brief Permutation. - * \ingroup block - * - * + * \ingroup coding_blk */ class trellis_permutation : public gr_sync_block { diff --git a/gr-trellis/src/lib/trellis_siso_combined_f.h b/gr-trellis/src/lib/trellis_siso_combined_f.h index 74436e352..6432c2262 100644 --- a/gr-trellis/src/lib/trellis_siso_combined_f.h +++ b/gr-trellis/src/lib/trellis_siso_combined_f.h @@ -44,8 +44,9 @@ trellis_siso_combined_f_sptr trellis_make_siso_combined_f ( trellis_metric_type_t TYPE ); - - +/*! + * \ingroup coding_blk + */ class trellis_siso_combined_f : public gr_block { fsm d_FSM; diff --git a/gr-trellis/src/lib/trellis_siso_f.h b/gr-trellis/src/lib/trellis_siso_f.h index efeced561..3e2c2498b 100644 --- a/gr-trellis/src/lib/trellis_siso_f.h +++ b/gr-trellis/src/lib/trellis_siso_f.h @@ -41,7 +41,9 @@ trellis_siso_f_sptr trellis_make_siso_f ( ); - +/*! + * \ingroup coding_blk + */ class trellis_siso_f : public gr_block { fsm d_FSM; diff --git a/gr-trellis/src/lib/trellis_viterbi_X.h.t b/gr-trellis/src/lib/trellis_viterbi_X.h.t index a61ed9ac9..67b46a8ee 100644 --- a/gr-trellis/src/lib/trellis_viterbi_X.h.t +++ b/gr-trellis/src/lib/trellis_viterbi_X.h.t @@ -39,6 +39,9 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; +/*! + * \ingroup coding_blk + */ class @NAME@ : public gr_block { fsm d_FSM; diff --git a/gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t b/gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t index ae5ccf841..21307d0e3 100644 --- a/gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t +++ b/gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t @@ -42,6 +42,9 @@ typedef boost::shared_ptr<@NAME@> @SPTR_NAME@; trellis_metric_type_t TYPE); +/*! + * \ingroup coding_blk + */ class @NAME@ : public gr_block { fsm d_FSM; diff --git a/gr-usrp/src/usrp_base.h b/gr-usrp/src/usrp_base.h index c106739d0..a914159e6 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 312bab246..b27813a42 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 b9c4b9499..e1d091d89 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. */ diff --git a/mblock/src/include/mblock/runtime.h b/mblock/src/include/mblock/runtime.h index 4d9d6736b..866875715 100644 --- a/mblock/src/include/mblock/runtime.h +++ b/mblock/src/include/mblock/runtime.h @@ -50,9 +50,10 @@ public: * This routine turns into the m-block scheduler, and * blocks until the system is shutdown. * - * \param name name of the top-level mblock (conventionally "top") + * \param instance_name name of the top-level mblock (conventionally "top") * \param class_name The class of the top-level mblock to create. * \param user_arg The argument to pass to the top-level mblock constructor + * \param result The value passed to shutdown_all. * * \returns true if the system ran successfully. */ diff --git a/usrp/host/lib/legacy/usrp_basic.h b/usrp/host/lib/legacy/usrp_basic.h index f77b9adc9..86c48635a 100644 --- a/usrp/host/lib/legacy/usrp_basic.h +++ b/usrp/host/lib/legacy/usrp_basic.h @@ -237,14 +237,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. @@ -782,6 +782,8 @@ protected: * \param fusb_block_size fast usb xfer block size. Must be a multiple of 512. * Use zero for a reasonable default. * \param fusb_nblocks number of fast usb URBs to allocate. Use zero for a reasonable default. + * \param fpga_filename name of the rbf file to load + * \param firmware_filename name of ihx file to load */ usrp_basic_rx (int which_board, int fusb_block_size=0, diff --git a/usrp/host/lib/legacy/usrp_standard.h b/usrp/host/lib/legacy/usrp_standard.h index 6dee62f30..734fff4b5 100644 --- a/usrp/host/lib/legacy/usrp_standard.h +++ b/usrp/host/lib/legacy/usrp_standard.h @@ -127,9 +127,15 @@ class usrp_standard_rx : public usrp_basic_rx, public usrp_standard_common * \brief invokes constructor, returns shared_ptr or shared_ptr equivalent of 0 if trouble * * \param which_board Which USRP board on usb (not particularly useful; use 0) + * \param decim_rate decimation factor + * \param nchan number of channels + * \param mux Rx mux setting, \sa set_mux + * \param mode mode * \param fusb_block_size fast usb xfer block size. Must be a multiple of 512. * Use zero for a reasonable default. * \param fusb_nblocks number of fast usb URBs to allocate. Use zero for a reasonable default. + * \param fpga_filename Name of rbf file to load + * \param firmware_filename Name of ihx file to load */ static usrp_standard_rx_sptr make(int which_board, unsigned int decim_rate, @@ -255,7 +261,7 @@ class usrp_standard_rx : public usrp_basic_rx, public usrp_standard_common * \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. */ @@ -329,9 +335,14 @@ class usrp_standard_tx : public usrp_basic_tx, public usrp_standard_common * \brief invokes constructor, returns shared_ptr or shared_ptr equivalent of 0 if trouble * * \param which_board Which USRP board on usb (not particularly useful; use 0) + * \param interp_rate interpolation factor + * \param nchan number of channels + * \param mux Tx mux setting, \sa set_mux * \param fusb_block_size fast usb xfer block size. Must be a multiple of 512. * Use zero for a reasonable default. * \param fusb_nblocks number of fast usb URBs to allocate. Use zero for a reasonable default. + * \param fpga_filename Name of rbf file to load + * \param firmware_filename Name of ihx file to load */ static usrp_standard_tx_sptr make(int which_board, unsigned int interp_rate, @@ -426,7 +437,7 @@ class usrp_standard_tx : public usrp_basic_tx, public usrp_standard_common * \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/usrp2/host/include/usrp2/usrp2.h b/usrp2/host/include/usrp2/usrp2.h index af1297b9a..7a612f945 100644 --- a/usrp2/host/include/usrp2/usrp2.h +++ b/usrp2/host/include/usrp2/usrp2.h @@ -89,6 +89,7 @@ namespace usrp2 { * \param addr Network mac address, e.g., "01:23:45:67:89:ab", "89:ab" or "". * If \p addr is HH:HH, it's treated as if it were 00:50:c2:85:HH:HH * "" will autoselect a USRP2 if there is only a single one on the local ethernet. + * \param rx_bufsize is the length in bytes of the kernel networking buffer to allocate. */ static sptr make(const std::string &ifc, const std::string &addr="", size_t rx_bufsize=0); |