Sample Doxygen File

Doxygen is nice for creating documentation from source files. Here is a sample Doxyfile: Usage: 1. Document a file

/**
  \file
  \brief File description */

2. Document a function

/**
  \param msg Message to be encoded
  \param G Generator matrix for the (n,k) non-extended Hamming encoder
  \return Encoded matrix
  \author Ustun Ozgur
*/

3. Document a struct/class etc.

/**
  \struct Params_Chase
  \brief Structure holding all the Chase-II decoder variables
  \param alpha Extrinsic info weight
  \param beta Reliability multiplier for bits with no competing codeword available
  \param btc_iter Number of iterations
  \param s Unreliable bits
*/

4. Change the main page

/*! \mainpage Block Turbo Coder
   \section ...
*/