在C ++中用Doxygen识别来评论代码区域

时间:2013-03-10 23:35:59

标签: doxygen

有没有办法添加一个注释块,Doxygen会将其理解为代码区域(由#pragma region描绘)?

换句话说,我想在一组函数之前发表评论,Doxygen会识别:

/**********************//**
* \some-doxygen-tag-here ?
**************************/
#pragma region Demo Functions
.....
.....
#pragma endregion

1 个答案:

答案 0 :(得分:0)

Doxygen模块组可以在这里提供帮助。组可以拥有文档,您可以标记组的开头和结尾。组在输出文档中称为模块(不确定是否可以轻松更改)。

/** @defgroup demofuns Demo Functions
 *  Documentation of the following code block, i. e. group.
 *  @{
 */
#pragma region Demo Functions
.....
.....
#pragma endregion
/** @} */ // end of demofuns

请参阅http://doxygen.org/manual/grouping.html