[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Commit-gnuradio] r11088 - in gnuradio/trunk: docs/doxygen/other gcell/i
|
From: |
eb |
|
Subject: |
[Commit-gnuradio] r11088 - in gnuradio/trunk: docs/doxygen/other gcell/include/gcell gcell/lib/runtime gnuradio-core/src/lib/filter gnuradio-core/src/lib/general gnuradio-core/src/lib/hier gnuradio-core/src/lib/runtime gr-audio-alsa/src gr-audio-jack/src gr-audio-portaudio/src gr-comedi/src gr-cvsd-vocoder/src/lib gr-gcell/src gr-gsm-fr-vocoder/src/lib gr-pager/src gr-trellis/src/lib gr-usrp/src mblock/src/include/mblock usrp/host/lib/legacy usrp2/host/include/usrp2 |
|
Date: |
Fri, 22 May 2009 15:22:23 -0600 (MDT) |
Author: eb
Date: 2009-05-22 15:22:22 -0600 (Fri, 22 May 2009)
New Revision: 11088
Modified:
gnuradio/trunk/docs/doxygen/other/group_defs.dox
gnuradio/trunk/docs/doxygen/other/main_page.dox
gnuradio/trunk/gcell/include/gcell/gc_job_desc.h
gnuradio/trunk/gcell/include/gcell/gc_job_manager.h
gnuradio/trunk/gcell/lib/runtime/gc_job_manager_impl.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h
gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_descrambler_bb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_sampler.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_correlator.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer.h
gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
gnuradio/trunk/gnuradio-core/src/lib/general/gri_fft.h
gnuradio/trunk/gnuradio-core/src/lib/hier/gr_channel_model.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_buffer.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2.h
gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_io_signature.h
gnuradio/trunk/gr-audio-alsa/src/audio_alsa_sink.h
gnuradio/trunk/gr-audio-alsa/src/audio_alsa_source.h
gnuradio/trunk/gr-audio-jack/src/audio_jack_sink.h
gnuradio/trunk/gr-audio-jack/src/audio_jack_source.h
gnuradio/trunk/gr-audio-portaudio/src/audio_portaudio_sink.h
gnuradio/trunk/gr-audio-portaudio/src/audio_portaudio_source.h
gnuradio/trunk/gr-comedi/src/comedi_sink_s.h
gnuradio/trunk/gr-comedi/src/comedi_source_s.h
gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h
gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h
gnuradio/trunk/gr-gcell/src/gcell_fft_vcc.h
gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h
gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h
gnuradio/trunk/gr-pager/src/pager_flex_deinterleave.h
gnuradio/trunk/gr-pager/src/pager_flex_parse.h
gnuradio/trunk/gr-pager/src/pager_flex_sync.h
gnuradio/trunk/gr-pager/src/pager_slicer_fb.h
gnuradio/trunk/gr-trellis/src/lib/trellis_encoder_XX.h.t
gnuradio/trunk/gr-trellis/src/lib/trellis_metrics_X.h.t
gnuradio/trunk/gr-trellis/src/lib/trellis_permutation.h
gnuradio/trunk/gr-trellis/src/lib/trellis_siso_combined_f.h
gnuradio/trunk/gr-trellis/src/lib/trellis_siso_f.h
gnuradio/trunk/gr-trellis/src/lib/trellis_viterbi_X.h.t
gnuradio/trunk/gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t
gnuradio/trunk/gr-usrp/src/usrp_base.h
gnuradio/trunk/gr-usrp/src/usrp_sink_base.h
gnuradio/trunk/gr-usrp/src/usrp_source_base.h
gnuradio/trunk/mblock/src/include/mblock/runtime.h
gnuradio/trunk/usrp/host/lib/legacy/usrp_basic.h
gnuradio/trunk/usrp/host/lib/legacy/usrp_standard.h
gnuradio/trunk/usrp2/host/include/usrp2/usrp2.h
Log:
Doc fixes.
Modified: gnuradio/trunk/docs/doxygen/other/group_defs.dox
===================================================================
--- gnuradio/trunk/docs/doxygen/other/group_defs.dox 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/docs/doxygen/other/group_defs.dox 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -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 */
Modified: gnuradio/trunk/docs/doxygen/other/main_page.dox
===================================================================
--- gnuradio/trunk/docs/doxygen/other/main_page.dox 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/docs/doxygen/other/main_page.dox 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -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!
+
*/
Modified: gnuradio/trunk/gcell/include/gcell/gc_job_desc.h
===================================================================
--- gnuradio/trunk/gcell/include/gcell/gc_job_desc.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gcell/include/gcell/gc_job_desc.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -171,6 +171,7 @@
/*!
* \brief "job description" that is DMA'd to/from the SPE.
+ * \ingroup gcell
*/
typedef struct gc_job_desc
{
Modified: gnuradio/trunk/gcell/include/gcell/gc_job_manager.h
===================================================================
--- gnuradio/trunk/gcell/include/gcell/gc_job_manager.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gcell/include/gcell/gc_job_manager.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -149,6 +149,7 @@
/*!
* \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 @@
/*!
* \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.
Modified: gnuradio/trunk/gcell/lib/runtime/gc_job_manager_impl.h
===================================================================
--- gnuradio/trunk/gcell/lib/runtime/gc_job_manager_impl.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gcell/lib/runtime/gc_job_manager_impl.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -248,10 +248,10 @@
/*!
* \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.
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_fsf_x86.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -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 @@
/*!
* \brief SSE version of gr_fir_fsf
- * \ingroup filter_blk
+ * \ingroup filter_primitive
*/
class gr_fir_fsf_sse : public gr_fir_fsf_simd
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/filter/gr_fir_scc_simd.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -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:
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_cc.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -39,7 +39,7 @@
/*!
* \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:
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_clock_recovery_mm_ff.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -39,7 +39,7 @@
/*!
* \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.
*
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_correlate_access_code_bb.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -38,7 +38,7 @@
/*!
* \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)
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_costas_loop_cc.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -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 @@
/*!
* \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 @@
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
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_dd_mpsk_sync_cc.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -37,7 +37,7 @@
/*!
* \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.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_descrambler_bb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_descrambler_bb.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_descrambler_bb.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -39,7 +39,7 @@
* \param seed Initial shift register contents
* \param len Shift register length
*
- * \ingroup misc
+ * \ingroup coding_blk
*/
class gr_descrambler_bb : public gr_sync_block
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_mpsk_receiver_cc.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -43,7 +43,8 @@
/*!
* \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.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_bpsk_demapper.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -37,9 +37,8 @@
/*!
* \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
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_cyclic_prefixer.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -36,7 +36,7 @@
/*!
* \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
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_demapper_vcb.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -37,8 +37,8 @@
* 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
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -40,6 +40,7 @@
* \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 @@
* \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
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_frame_sink.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -39,6 +39,8 @@
* \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.
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_insert_preamble.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -34,7 +34,8 @@
/*!
* \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]
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_mapper_bcv.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -39,7 +39,7 @@
* 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
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_sampler.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_sampler.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_ofdm_sampler.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -34,9 +34,8 @@
/*!
* \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,
Modified:
gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_carriertracking_cc.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -33,7 +33,7 @@
/*!
* \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
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_freqdet_cf.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -33,7 +33,7 @@
/*!
* \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
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pll_refout_cc.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -34,7 +34,7 @@
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
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_pn_correlator_cc.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -34,7 +34,7 @@
/*!
* \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
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_correlator.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_correlator.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_correlator.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -35,7 +35,7 @@
/*!
* \brief inverse of gr_simple_framer (more or less)
- * \ingroup synch_blk
+ * \ingroup sync_blk
*/
class gr_simple_correlator : public gr_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -32,7 +32,7 @@
/*!
* \brief add sync field, seq number and command field to payload
- * \ingroup synch_blk
+ * \ingroup sync_blk
*/
class gr_simple_framer : public gr_block
{
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gr_simple_framer_sync.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -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;
Modified: gnuradio/trunk/gnuradio-core/src/lib/general/gri_fft.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/general/gri_fft.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/general/gri_fft.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -75,7 +75,7 @@
/*!
* \brief FFT: real in, complex out
- * \ingroup dft_blk
+ * \ingroup misc
*/
class gri_fft_real_fwd {
int d_fft_size;
@@ -106,7 +106,7 @@
/*!
* \brief FFT: complex in, float out
- * \ingroup dft_blk
+ * \ingroup misc
*/
class gri_fft_real_rev {
int d_fft_size;
Modified: gnuradio/trunk/gnuradio-core/src/lib/hier/gr_channel_model.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/hier/gr_channel_model.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/hier/gr_channel_model.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -37,6 +37,10 @@
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:
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_buffer.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_buffer.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_buffer.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -163,7 +163,8 @@
};
/*!
- * \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.
*/
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_hier_block2.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -35,7 +35,7 @@
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
*
Modified: gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_io_signature.h
===================================================================
--- gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_io_signature.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gnuradio-core/src/lib/runtime/gr_io_signature.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -98,7 +98,7 @@
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:
Modified: gnuradio/trunk/gr-audio-alsa/src/audio_alsa_sink.h
===================================================================
--- gnuradio/trunk/gr-audio-alsa/src/audio_alsa_sink.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-audio-alsa/src/audio_alsa_sink.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -40,12 +40,12 @@
* \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);
/*!
Modified: gnuradio/trunk/gr-audio-alsa/src/audio_alsa_source.h
===================================================================
--- gnuradio/trunk/gr-audio-alsa/src/audio_alsa_source.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-audio-alsa/src/audio_alsa_source.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -39,12 +39,12 @@
* \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);
/*!
Modified: gnuradio/trunk/gr-audio-jack/src/audio_jack_sink.h
===================================================================
--- gnuradio/trunk/gr-audio-jack/src/audio_jack_sink.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-audio-jack/src/audio_jack_sink.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -35,12 +35,12 @@
* \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);
Modified: gnuradio/trunk/gr-audio-jack/src/audio_jack_source.h
===================================================================
--- gnuradio/trunk/gr-audio-jack/src/audio_jack_source.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-audio-jack/src/audio_jack_source.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -35,12 +35,12 @@
* \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);
Modified: gnuradio/trunk/gr-audio-portaudio/src/audio_portaudio_sink.h
===================================================================
--- gnuradio/trunk/gr-audio-portaudio/src/audio_portaudio_sink.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-audio-portaudio/src/audio_portaudio_sink.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -37,12 +37,12 @@
* \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;
Modified: gnuradio/trunk/gr-audio-portaudio/src/audio_portaudio_source.h
===================================================================
--- gnuradio/trunk/gr-audio-portaudio/src/audio_portaudio_source.h
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-audio-portaudio/src/audio_portaudio_source.h
2009-05-22 21:22:22 UTC (rev 11088)
@@ -37,12 +37,12 @@
* \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;
Modified: gnuradio/trunk/gr-comedi/src/comedi_sink_s.h
===================================================================
--- gnuradio/trunk/gr-comedi/src/comedi_sink_s.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-comedi/src/comedi_sink_s.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -49,7 +49,7 @@
*/
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,
Modified: gnuradio/trunk/gr-comedi/src/comedi_source_s.h
===================================================================
--- gnuradio/trunk/gr-comedi/src/comedi_source_s.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-comedi/src/comedi_source_s.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -49,7 +49,7 @@
*/
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,
Modified: gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h
===================================================================
--- gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_decode_bs.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -57,7 +57,7 @@
* 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
Modified: gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h
===================================================================
--- gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-cvsd-vocoder/src/lib/cvsd_encode_sb.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -58,7 +58,7 @@
* 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
Modified: gnuradio/trunk/gr-gcell/src/gcell_fft_vcc.h
===================================================================
--- gnuradio/trunk/gr-gcell/src/gcell_fft_vcc.h 2009-05-22 21:16:37 UTC (rev
11087)
+++ gnuradio/trunk/gr-gcell/src/gcell_fft_vcc.h 2009-05-22 21:22:22 UTC (rev
11088)
@@ -36,6 +36,7 @@
/*!
* \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.
*/
Modified: gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h
===================================================================
--- gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_decode_ps.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -31,7 +31,7 @@
/*!
* \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;
Modified: gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h
===================================================================
--- gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-gsm-fr-vocoder/src/lib/gsm_fr_encode_sp.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -31,7 +31,7 @@
/*!
* \brief GSM 06.10 Full Rate Vocoder Encoder
- * \ingroup vocoder
+ * \ingroup vocoder_blk
*
* shorts in; 33 byte packets out
*/
Modified: gnuradio/trunk/gr-pager/src/pager_flex_deinterleave.h
===================================================================
--- gnuradio/trunk/gr-pager/src/pager_flex_deinterleave.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-pager/src/pager_flex_deinterleave.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -31,7 +31,7 @@
/*!
* \brief flex deinterleave description
- * \ingroup block
+ * \ingroup pager_blk
*/
class pager_flex_deinterleave : public gr_sync_decimator
Modified: gnuradio/trunk/gr-pager/src/pager_flex_parse.h
===================================================================
--- gnuradio/trunk/gr-pager/src/pager_flex_parse.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-pager/src/pager_flex_parse.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -32,13 +32,12 @@
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:
Modified: gnuradio/trunk/gr-pager/src/pager_flex_sync.h
===================================================================
--- gnuradio/trunk/gr-pager/src/pager_flex_sync.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-pager/src/pager_flex_sync.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -32,7 +32,7 @@
/*!
* \brief flex sync description
- * \ingroup block
+ * \ingroup pager_blk
*/
class pager_flex_sync : public gr_block
Modified: gnuradio/trunk/gr-pager/src/pager_slicer_fb.h
===================================================================
--- gnuradio/trunk/gr-pager/src/pager_slicer_fb.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-pager/src/pager_slicer_fb.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -31,7 +31,7 @@
/*!
* \brief slicer description
- * \ingroup block
+ * \ingroup pager_blk
*/
class pager_slicer_fb : public gr_sync_block
{
Modified: gnuradio/trunk/gr-trellis/src/lib/trellis_encoder_XX.h.t
===================================================================
--- gnuradio/trunk/gr-trellis/src/lib/trellis_encoder_XX.h.t 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-trellis/src/lib/trellis_encoder_XX.h.t 2009-05-22
21:22:22 UTC (rev 11088)
@@ -35,9 +35,7 @@
/*!
* \brief Convolutional encoder.
- * \ingroup block
- *
- *
+ * \ingroup coding_blk
*/
class @NAME@ : public gr_sync_block
{
Modified: gnuradio/trunk/gr-trellis/src/lib/trellis_metrics_X.h.t
===================================================================
--- gnuradio/trunk/gr-trellis/src/lib/trellis_metrics_X.h.t 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-trellis/src/lib/trellis_metrics_X.h.t 2009-05-22
21:22:22 UTC (rev 11088)
@@ -35,8 +35,7 @@
/*!
* \brief Evaluate metrics for use by the Viterbi algorithm.
- * \ingroup block
- *
+ * \ingroup coding_blk
*/
class @NAME@ : public gr_block
{
Modified: gnuradio/trunk/gr-trellis/src/lib/trellis_permutation.h
===================================================================
--- gnuradio/trunk/gr-trellis/src/lib/trellis_permutation.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-trellis/src/lib/trellis_permutation.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -34,9 +34,7 @@
/*!
* \brief Permutation.
- * \ingroup block
- *
- *
+ * \ingroup coding_blk
*/
class trellis_permutation : public gr_sync_block
{
Modified: gnuradio/trunk/gr-trellis/src/lib/trellis_siso_combined_f.h
===================================================================
--- gnuradio/trunk/gr-trellis/src/lib/trellis_siso_combined_f.h 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-trellis/src/lib/trellis_siso_combined_f.h 2009-05-22
21:22:22 UTC (rev 11088)
@@ -44,8 +44,9 @@
trellis_metric_type_t TYPE
);
-
-
+/*!
+ * \ingroup coding_blk
+ */
class trellis_siso_combined_f : public gr_block
{
fsm d_FSM;
Modified: gnuradio/trunk/gr-trellis/src/lib/trellis_siso_f.h
===================================================================
--- gnuradio/trunk/gr-trellis/src/lib/trellis_siso_f.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-trellis/src/lib/trellis_siso_f.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -41,7 +41,9 @@
);
-
+/*!
+ * \ingroup coding_blk
+ */
class trellis_siso_f : public gr_block
{
fsm d_FSM;
Modified: gnuradio/trunk/gr-trellis/src/lib/trellis_viterbi_X.h.t
===================================================================
--- gnuradio/trunk/gr-trellis/src/lib/trellis_viterbi_X.h.t 2009-05-22
21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-trellis/src/lib/trellis_viterbi_X.h.t 2009-05-22
21:22:22 UTC (rev 11088)
@@ -39,6 +39,9 @@
+/*!
+ * \ingroup coding_blk
+ */
class @NAME@ : public gr_block
{
fsm d_FSM;
Modified: gnuradio/trunk/gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t
===================================================================
--- gnuradio/trunk/gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t
2009-05-22 21:16:37 UTC (rev 11087)
+++ gnuradio/trunk/gr-trellis/src/lib/trellis_viterbi_combined_XX.h.t
2009-05-22 21:22:22 UTC (rev 11088)
@@ -42,6 +42,9 @@
trellis_metric_type_t TYPE);
+/*!
+ * \ingroup coding_blk
+ */
class @NAME@ : public gr_block
{
fsm d_FSM;
Modified: gnuradio/trunk/gr-usrp/src/usrp_base.h
===================================================================
--- gnuradio/trunk/gr-usrp/src/usrp_base.h 2009-05-22 21:16:37 UTC (rev
11087)
+++ gnuradio/trunk/gr-usrp/src/usrp_base.h 2009-05-22 21:22:22 UTC (rev
11088)
@@ -152,14 +152,14 @@
/*!
* \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.
Modified: gnuradio/trunk/gr-usrp/src/usrp_sink_base.h
===================================================================
--- gnuradio/trunk/gr-usrp/src/usrp_sink_base.h 2009-05-22 21:16:37 UTC (rev
11087)
+++ gnuradio/trunk/gr-usrp/src/usrp_sink_base.h 2009-05-22 21:22:22 UTC (rev
11088)
@@ -55,13 +55,13 @@
/*!
* \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 @@
* \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.
*/
Modified: gnuradio/trunk/gr-usrp/src/usrp_source_base.h
===================================================================
--- gnuradio/trunk/gr-usrp/src/usrp_source_base.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/gr-usrp/src/usrp_source_base.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -65,13 +65,13 @@
/*!
* \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 @@
* \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.
*/
Modified: gnuradio/trunk/mblock/src/include/mblock/runtime.h
===================================================================
--- gnuradio/trunk/mblock/src/include/mblock/runtime.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/mblock/src/include/mblock/runtime.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -50,9 +50,10 @@
* 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.
*/
Modified: gnuradio/trunk/usrp/host/lib/legacy/usrp_basic.h
===================================================================
--- gnuradio/trunk/usrp/host/lib/legacy/usrp_basic.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/usrp/host/lib/legacy/usrp_basic.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -237,14 +237,14 @@
/*!
* \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 @@
* \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,
Modified: gnuradio/trunk/usrp/host/lib/legacy/usrp_standard.h
===================================================================
--- gnuradio/trunk/usrp/host/lib/legacy/usrp_standard.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/usrp/host/lib/legacy/usrp_standard.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -127,9 +127,15 @@
* \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 @@
* \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 @@
* \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 @@
* \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.
*/
Modified: gnuradio/trunk/usrp2/host/include/usrp2/usrp2.h
===================================================================
--- gnuradio/trunk/usrp2/host/include/usrp2/usrp2.h 2009-05-22 21:16:37 UTC
(rev 11087)
+++ gnuradio/trunk/usrp2/host/include/usrp2/usrp2.h 2009-05-22 21:22:22 UTC
(rev 11088)
@@ -89,6 +89,7 @@
* \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);
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Commit-gnuradio] r11088 - in gnuradio/trunk: docs/doxygen/other gcell/include/gcell gcell/lib/runtime gnuradio-core/src/lib/filter gnuradio-core/src/lib/general gnuradio-core/src/lib/hier gnuradio-core/src/lib/runtime gr-audio-alsa/src gr-audio-jack/src gr-audio-portaudio/src gr-comedi/src gr-cvsd-vocoder/src/lib gr-gcell/src gr-gsm-fr-vocoder/src/lib gr-pager/src gr-trellis/src/lib gr-usrp/src mblock/src/include/mblock usrp/host/lib/legacy usrp2/host/include/usrp2,
eb <=