Header doc format

Class headers

/**
* @ingroup <Group related classes together>
*
* <Class description>
*/

Method headers

/*
* <Description>
*
* @param [in] <Input parameter description>
* @param [in] <Input parameter description>
*
* @return 0 <Output value and description>
* @return -1 <Output value and description>
*
* Example:
* @code
* {
* <Code example snippet>
* }
* @endcode
*
* @see <Related methods>
*/

Others (#define/enum/typedef)

/**
* <single line description>
*
* <Detailed paragraph description if needed>
*/

Notes:

• Don't use @brief or @abstract or @discussion anywhere
• For descriptions of variables, use the multi-line comment as shown above in "Others"