[Commit-gnuradio] [gnuradio] 02/08: docs: Fixing some missing parameters and other Doxygen errors/warnings.

[git]

This is an automated email from the git hooks/post-receive script.

jcorgan pushed a commit to branch maint
in repository gnuradio.

commit 290c69fb0b008cdfd351bd0dc84b493cd0e5d6c7
Author: Tom Rondeau <address@hidden>
Date:   Tue Apr 28 11:23:38 2015 -0400

    docs: Fixing some missing parameters and other Doxygen errors/warnings.
---
 docs/doxygen/other/build_guide.dox                 |  4 ++--
 .../include/gnuradio/blocks/tagged_stream_align.h  |  4 ++--
 gr-fec/include/gnuradio/fec/awgn_bp.h              | 11 +++++-----
 gr-fec/include/gnuradio/fec/gf2mat.h               | 25 +++++++++++-----------
 4 files changed, 23 insertions(+), 21 deletions(-)

diff --git a/docs/doxygen/other/build_guide.dox 
b/docs/doxygen/other/build_guide.dox
index c21b987..def85df 100644
--- a/docs/doxygen/other/build_guide.dox
+++ b/docs/doxygen/other/build_guide.dox
@@ -1,4 +1,4 @@
-/*! \page build_guide Build Instructions and Information
+        /*! \page build_guide Build Instructions and Information
 
 \section dependencies Dependencies
 
@@ -165,7 +165,7 @@ If not specified, the "Release" mode is the default.
 
 Here are som other potentially helpful CMake flags. These are to help you 
specifically locate certain dependencies. While the CMake scripts themselves 
should generally find these for us, we can use these to help direct CMake to 
specific locations if we have installed a different version elsewhere on the 
system that CMake doesn't know about.
 
-\li QWT_LIBRARIES: shared library to use for Qwt (in the form 
<path>/libqwt.so).
+\li QWT_LIBRARIES: shared library to use for Qwt (in the form 
\<path\>/libqwt.so).
 \li QWT_INCLUDE_DIRS: path to Qwt include files (e.g., /usr/include/qwt).
 \li PYTHON_EXECUTABLE: Location of the 'python' binary you want to use (e.g., 
/usr/bin/python2.7).
 \li PYTHON_INCLUDE_PATH: path to Python include files (e.g., 
/usr/include/python2.7).
diff --git a/gr-blocks/include/gnuradio/blocks/tagged_stream_align.h 
b/gr-blocks/include/gnuradio/blocks/tagged_stream_align.h
index 9796293..ae01198 100644
--- a/gr-blocks/include/gnuradio/blocks/tagged_stream_align.h
+++ b/gr-blocks/include/gnuradio/blocks/tagged_stream_align.h
@@ -43,7 +43,8 @@ namespace gr {
       /*!
        * Make a tagged stream align
        *
-       * \param lengthtagname Length tag key
+       * \param itemsize The size (in bytes) of the item datatype.
+       * \param lengthtagname Name of the TSB's length tag key.
        */
       static sptr make(size_t itemsize, const std::string &lengthtagname);
     };
@@ -52,4 +53,3 @@ namespace gr {
 } // namespace gr
 
 #endif /* INCLUDED_TAGGED_STREAM_ALIGN_H */
-
diff --git a/gr-fec/include/gnuradio/fec/awgn_bp.h 
b/gr-fec/include/gnuradio/fec/awgn_bp.h
index f420d76..62fe7e2 100644
--- a/gr-fec/include/gnuradio/fec/awgn_bp.h
+++ b/gr-fec/include/gnuradio/fec/awgn_bp.h
@@ -119,13 +119,14 @@ class FEC_API awgn_bp
     int get_max_iterations();
 
     /*!
-      \brief Decodes the given vector rx_word by message passing.
-
-      \param *niterations is the number of message passing iterations
-      done to decode this codeword
+     * \brief Decodes the given vector rx_word by message passing.
+     *
+     * \param rx_word The received samples for decoding.
+     * \param niterations The number of message passing iterations
+     *        done to decode this codeword.
     */
     std::vector<char> decode (std::vector<float> rx_word,
-            int *niterations);
+                              int *niterations);
   private:
     //! The number of check nodes in the tanner-graph
     int M;
diff --git a/gr-fec/include/gnuradio/fec/gf2mat.h 
b/gr-fec/include/gnuradio/fec/gf2mat.h
index 963b208..51aa310 100644
--- a/gr-fec/include/gnuradio/fec/gf2mat.h
+++ b/gr-fec/include/gnuradio/fec/gf2mat.h
@@ -54,7 +54,7 @@ class GF2Mat
     int get_M();
 
     //! Returns the variable N
-    int get_N(); 
+    int get_N();
 
     //! Set the element at (i, j) coordinate to val
     void set_element(int i, int j, char val);
@@ -93,17 +93,18 @@ class GF2Mat
     std::vector<std::vector<char> > get_H();
 
     /*!
-      \brief Obtains an equivalent representation of H for encoding
-
-      For encoding a G matrix in the form [I P] is obtained from the
-      parity matrix H, by (a) Column permutations, (b) Row additions
-      and (c) Row permutations. Details of encoding is given in
-      section A.1 of the reference given below.
-       - "Modern Coding Theory", T Richardson and R Urbanke.
-
-      \param p is the column permutation during this operation
-      \
-    */
+     * \brief Obtains an equivalent representation of H for encoding
+     *
+     * For encoding a G matrix in the form [I P] obtained from the
+     * parity matrix H, by (a) Column permutations, (b) Row additions
+     * and (c) Row permutations. Details of encoding is given in
+     * section A.1 of the reference:
+     *
+     *  - "Modern Coding Theory", T Richardson and R Urbanke.
+     *
+     * \param p The column permutation during this operation.
+     * \param rank The rank of the matrix.
+     */
     GF2Mat get_G(std::vector<int> & p, int & rank);
 
 };