miscellaneous_tips:20_software_development:doxygen_tips

Doxygen Tips

/**
 * @brief divide one number by another one.
 * 
 * @note Parameter @p divisor 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;
}
typedef struct
{
  int valid;        ///< Indicates if #my_data is valid.
  int my_data;      ///< My data, only valid if #valid is != 0.
};

Martin Burnicki martin.burnicki@burnicki.net 2019-04-26

  • miscellaneous_tips/20_software_development/doxygen_tips.txt
  • Zuletzt geändert: 2021-01-18 17:20
  • (Externe Bearbeitung)