diff options
author | Tom Rondeau <trondeau@vt.edu> | 2012-08-28 00:02:52 -0400 |
---|---|---|
committer | Tom Rondeau <trondeau@vt.edu> | 2012-08-28 00:02:52 -0400 |
commit | 7e312ed50faf64705089ee550000efd34c719c57 (patch) | |
tree | d5fe4356166b3e9f963a71ebaa61babafe120198 | |
parent | 285ea24f3f033e97a907c01c6b135ca8662d8a8f (diff) |
docs: fixed doxygen markup issues.
-rw-r--r-- | docs/doxygen/other/pfb_intro.dox | 2 | ||||
-rw-r--r-- | gnuradio-core/src/lib/general/gr_simple_correlator.cc | 4 | ||||
-rw-r--r-- | gnuradio-core/src/lib/gengen/gr_vector_insert_X.cc.t | 2 | ||||
-rw-r--r-- | gr-digital/include/digital/ofdm_frame_sink.h | 4 | ||||
-rw-r--r-- | gr-digital/include/digital/ofdm_mapper_bcv.h | 2 | ||||
-rw-r--r-- | gr-digital/include/digital/pn_correlator_cc.h | 1 | ||||
-rw-r--r-- | gr-digital/include/digital/scrambler_bb.h | 2 | ||||
-rw-r--r-- | gr-filter/include/filter/pfb_decimator_ccf.h | 2 | ||||
-rw-r--r-- | gr-qtgui/include/qtgui/freq_sink_c.h | 2 | ||||
-rw-r--r-- | gr-qtgui/include/qtgui/freq_sink_f.h | 2 | ||||
-rw-r--r-- | gr-qtgui/include/qtgui/sink_c.h | 7 | ||||
-rw-r--r-- | gr-qtgui/include/qtgui/sink_f.h | 7 |
12 files changed, 23 insertions, 14 deletions
diff --git a/docs/doxygen/other/pfb_intro.dox b/docs/doxygen/other/pfb_intro.dox index 01d08b0fad..429e8fe5b6 100644 --- a/docs/doxygen/other/pfb_intro.dox +++ b/docs/doxygen/other/pfb_intro.dox @@ -91,6 +91,6 @@ channels. NOTE: you need the Scipy and Matplotlib Python modules installed to run this example. -\include gnuradio-core/src/examples/pfb/channelize.py +\include gr-filter/examples/channelize.py */ diff --git a/gnuradio-core/src/lib/general/gr_simple_correlator.cc b/gnuradio-core/src/lib/general/gr_simple_correlator.cc index 9c2ebef15a..b9209e74f0 100644 --- a/gnuradio-core/src/lib/general/gr_simple_correlator.cc +++ b/gnuradio-core/src/lib/general/gr_simple_correlator.cc @@ -158,11 +158,13 @@ gr_simple_correlator::general_work (int noutput_items, int decision; int hamming_dist; +#ifdef DEBUG_SIMPLE_CORRELATOR struct debug_data { float raw_data; float sampled; float enter_locked; } debug_data; +#endif while (n < nin){ @@ -212,7 +214,9 @@ gr_simple_correlator::general_work (int noutput_items, else if (d_state == ST_UNDER_THRESHOLD && hamming_dist > THRESHOLD){ // no longer seeing good PN code, compute center of goodness enter_locked (); +#ifdef DEBUG_SIMPLE_CORRELATOR debug_data.enter_locked = 1.0; +#endif } break; diff --git a/gnuradio-core/src/lib/gengen/gr_vector_insert_X.cc.t b/gnuradio-core/src/lib/gengen/gr_vector_insert_X.cc.t index 37963cdfee..20968afe22 100644 --- a/gnuradio-core/src/lib/gengen/gr_vector_insert_X.cc.t +++ b/gnuradio-core/src/lib/gengen/gr_vector_insert_X.cc.t @@ -44,7 +44,7 @@ // some sanity checks assert(offset < periodicity); assert(offset >= 0); - assert(periodicity > data.size()); + assert((size_t)periodicity > data.size()); } int diff --git a/gr-digital/include/digital/ofdm_frame_sink.h b/gr-digital/include/digital/ofdm_frame_sink.h index 2b4bbe6480..427d6eb460 100644 --- a/gr-digital/include/digital/ofdm_frame_sink.h +++ b/gr-digital/include/digital/ofdm_frame_sink.h @@ -52,9 +52,9 @@ namespace gr { * Make an OFDM frame sink block. * * \param sym_position vector of OFDM carrier symbols in complex space - * \param sym_value vector of bit mapped from the complex symbol space + * \param sym_value_out vector of bit mapped from the complex symbol space * \param target_queue message queue for the packets to go into - * \param occupied_carriers The number of subcarriers with data in the received symbol + * \param occupied_tones The number of subcarriers with data in the received symbol * \param phase_gain gain of the phase tracking loop * \param freq_gain gain of the frequency tracking loop */ diff --git a/gr-digital/include/digital/ofdm_mapper_bcv.h b/gr-digital/include/digital/ofdm_mapper_bcv.h index d694cec835..1e541d2edb 100644 --- a/gr-digital/include/digital/ofdm_mapper_bcv.h +++ b/gr-digital/include/digital/ofdm_mapper_bcv.h @@ -48,7 +48,7 @@ namespace gr { /*! * Make an OFDM mapper block. * - * \param sym_position vector of OFDM carrier symbols in complex space + * \param constellation vector of OFDM carrier symbols in complex space * \param msgq_limit limit on number of messages the queue can store * \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) diff --git a/gr-digital/include/digital/pn_correlator_cc.h b/gr-digital/include/digital/pn_correlator_cc.h index bb881fe5b7..257cbbfe01 100644 --- a/gr-digital/include/digital/pn_correlator_cc.h +++ b/gr-digital/include/digital/pn_correlator_cc.h @@ -50,7 +50,6 @@ namespace gr { * \param degree Degree of shift register must be in [1, 32]. If mask * is 0, the degree determines a default mask (see * digital_impl_glfsr.cc for the mapping). - * \param repeat Set to repeat sequence. * \param mask Allows a user-defined bit mask for indexes of the shift * register to feed back. * \param seed Initial setting for values in shift register. diff --git a/gr-digital/include/digital/scrambler_bb.h b/gr-digital/include/digital/scrambler_bb.h index 1114cd6056..95fce6dad7 100644 --- a/gr-digital/include/digital/scrambler_bb.h +++ b/gr-digital/include/digital/scrambler_bb.h @@ -30,7 +30,7 @@ namespace gr { namespace digital { /*! - * \breif Scramble an input stream using an LFSR. + * \brief Scramble an input stream using an LFSR. * \ingroup coding_blk * * This block works on the LSB only of the input data stream, diff --git a/gr-filter/include/filter/pfb_decimator_ccf.h b/gr-filter/include/filter/pfb_decimator_ccf.h index bf9d0d9508..e1a43eab83 100644 --- a/gr-filter/include/filter/pfb_decimator_ccf.h +++ b/gr-filter/include/filter/pfb_decimator_ccf.h @@ -56,7 +56,7 @@ namespace gr { * * The output signal will be the basebanded and decimated signal * from that channel. This concept is very similar to the PFB - * channelizer (see #gr_pfb_channelizer_ccf) where only a single + * channelizer (see #gr::filter::pfb_channelizer_ccf) where only a single * channel is extracted at a time. * * The filter's taps should be based on the sampling rate before diff --git a/gr-qtgui/include/qtgui/freq_sink_c.h b/gr-qtgui/include/qtgui/freq_sink_c.h index e1c30080c2..2bef9035e8 100644 --- a/gr-qtgui/include/qtgui/freq_sink_c.h +++ b/gr-qtgui/include/qtgui/freq_sink_c.h @@ -52,7 +52,7 @@ namespace gr { /*! * \brief Build a complex PSD sink. * - * \param size size of the FFT to compute and display + * \param fftsize size of the FFT to compute and display * \param wintype type of window to apply (see filter/firdes.h) * \param fc center frequency of signal (use for x-axis labels) * \param bw bandwidth of signal (used to set x-axis labels) diff --git a/gr-qtgui/include/qtgui/freq_sink_f.h b/gr-qtgui/include/qtgui/freq_sink_f.h index 6b7d1717b5..51c4ac10a1 100644 --- a/gr-qtgui/include/qtgui/freq_sink_f.h +++ b/gr-qtgui/include/qtgui/freq_sink_f.h @@ -52,7 +52,7 @@ namespace gr { /*! * \brief Build a floating point PSD sink. * - * \param size size of the FFT to compute and display + * \param fftsize size of the FFT to compute and display * \param wintype type of window to apply (see filter/firdes.h) * \param fc center frequency of signal (use for x-axis labels) * \param bw bandwidth of signal (used to set x-axis labels) diff --git a/gr-qtgui/include/qtgui/sink_c.h b/gr-qtgui/include/qtgui/sink_c.h index b844ca7777..f8d58ddbe0 100644 --- a/gr-qtgui/include/qtgui/sink_c.h +++ b/gr-qtgui/include/qtgui/sink_c.h @@ -54,12 +54,15 @@ namespace gr { /*! * \brief Build a complex qtgui sink. * - * \param size size of the FFT to compute and display + * \param fftsize size of the FFT to compute and display * \param wintype type of window to apply (see filter/firdes.h) * \param fc center frequency of signal (use for x-axis labels) * \param bw bandwidth of signal (used to set x-axis labels) * \param name title for the plot - * \param nconnections number of signals connected to sink + * \param plotfreq Toggle frequency plot on/off + * \param plotwaterfall Toggle waterfall plot on/off + * \param plottime Toggle time plot on/off + * \param plotconst Toggle constellation plot on/off * \param parent a QWidget parent object, if any */ static sptr make(int fftsize, int wintype, diff --git a/gr-qtgui/include/qtgui/sink_f.h b/gr-qtgui/include/qtgui/sink_f.h index 961a5d561f..0af49ba9e2 100644 --- a/gr-qtgui/include/qtgui/sink_f.h +++ b/gr-qtgui/include/qtgui/sink_f.h @@ -54,12 +54,15 @@ namespace gr { /*! * \brief Build a floating point qtgui sink. * - * \param size size of the FFT to compute and display + * \param fftsize size of the FFT to compute and display * \param wintype type of window to apply (see filter/firdes.h) * \param fc center frequency of signal (use for x-axis labels) * \param bw bandwidth of signal (used to set x-axis labels) * \param name title for the plot - * \param nconnections number of signals connected to sink + * \param plotfreq Toggle frequency plot on/off + * \param plotwaterfall Toggle waterfall plot on/off + * \param plottime Toggle time plot on/off + * \param plotconst Toggle constellation plot on/off * \param parent a QWidget parent object, if any */ static sptr make(int fftsize, int wintype, |