Merge branch 'patches/marcus/file_sink'

[debian/gnuradio] / gnuradio-core / src / lib / general / gr_ofdm_frame_acquisition.h

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 af63f3e4c26763ea3561cb278201a5cbd2741d80..5db8dbb7f59bd108f7173a20916ea352d6783dc0 100644 (file)
--- a/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
+++ b/gnuradio-core/src/lib/general/gr_ofdm_frame_acquisition.h
@@ -39,7 +39,8 @@ 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.
- * \inblock blocks
+ * \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
@@ -81,7 +79,7 @@ protected:
   
  private:
   unsigned char slicer(gr_complex x);
-  bool correlate(const gr_complex *symbol, int zeros_on_left);
+  void correlate(const gr_complex *symbol, int zeros_on_left);
   void calculate_equalizer(const gr_complex *symbol, int zeros_on_left);
   gr_complex coarse_freq_comp(int freq_delta, int count);