关键字 | 说明 | |
/** * @brief 函数摘要介绍 * @param[in] id 输入参数ID * @param[in] reason 理由 * @return int * @retval -1 失败 * @retval 0 成功 * @note 附加说明。\n 目的:\n abcd\n 举例:\n 123456 \n * @warning 注意事项内容A, \n * 注意事项内容B,\n * @par 附加说明 * @code ... //代码样例: if (test1(context) == 0) { } else { } ... * @endcode */ int test1(void* context); | ||
@defgroup | 定义组 | /** ....//此处定义组内接口们 /** @} */ |
@ingroup | 声明所属组 | /** * @defgroup group1 sub1 * @{ * @ingroup group1 * @brief group1 的sub1相关接口 */ |
/**
* @defgroup group1
* @{
* @brief group1 相关接口. \n
* ...
*/
/** @} */
/**
* @defgroup group1 sub1
* @{
* @ingroup group1
* @brief group1 的sub1相关接口
*/
/**
* @brief 函数摘要介绍
* @param[in] id 输入参数ID
* @param[in] reason 理由
* @return int
* @retval -1 失败
* @retval 0 成功
* @note 附加说明。\n
目的:\n
abcd\n
举例:\n
123456 \n
* @warning 注意事项内容A, \n
* 注意事项内容B,\n
* @par 附加说明
* @code
...
//代码样例:
if (test1(context) == 0) {
} else {
}
...
* @endcode
*/
int test1(void* context);
/** @} */