Open svhawkins opened 10 months ago
Add more structured comments, especially for functions and structs
for functions and/or member functions:
/** *@name *@brief <brief description of function> *@param <parameter name> <description, include type> *@param <parameter name> <description, include type> *... *@return <descritption, include type> * * <optional> detailed description * - highlight failure cases * - highlight special cases * - highlight behavior/state changes */
for structures/classes:
/* * structure name * @brief <description> * @member <type : member variable name> <description> */
Add more structured comments, especially for functions and structs
for functions and/or member functions:
for structures/classes: