====== Doxygen Tips ======


===== Referring function parameters in a description =====

<codedoc code>
/**
 * @brief divide one number by another one.
 * 
 * @note Parameter ~~codedoc:<b>@p divisor</b>~~ must not be 0!
 *
 * @param[in]  dividend  The first number. 
 * @param[in]  divisor   The second number.
 *
 * @return The quotient.
 */
double divide( double dividend, double divisor )
{
  return dividend / divisor;
}
</codedoc>



===== Referring other struct fields in a description =====

<codedoc code>
typedef struct
{
  int valid;        ///< Indicates if ~~codedoc:<b>#my_data</b>~~ is valid.
  int my_data;      ///< My data, only valid if ~~codedoc:<b>#valid</b>~~ is != 0.
};
</codedoc>


----

 --- //Martin Burnicki [[martin.burnicki@burnicki.net]] 2019-04-26//