Doc fixes.

git-svn-id: http://gnuradio.org/svn/gnuradio/trunk@11088 221aa14e-8319-0410-a670-987f0aec2ac5

29 files changed, 43 insertions, 38 deletions

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: