基本上我想继续关注部分之后的常规文本流程。如果我留下换行符,doxygen将不会将换行符之前的文本与项目的文档相关联。是否有一般方法可以结束任意部分,例如@attention
,而不将整个部分(即@attention
)放在另一个块中并终止它。
修改
例如,给定
///this is a function
///@attention attention text
///should be outside attention text
void testFunc() {};
doxygen输出如下:
void testFunc()
应该是外部关注文本
这是一个功能
注意:
关注文本
即。文本的顺序已更改。
更新
另一个类似的问题:在文件的开头我有:
///@author Somebody
///
#define MY_MACRO printf
作者与宏关联,而不是与整个文件关联。如果我在@author
之后添加一个空注释行,我会得到相同的结果
通常,当没有像@endcode
这样的明确结束宏时,是否存在一种在doxygen中结束块的通用方法。
答案 0 :(得分:2)
试试这个:
///this is a function
///@attention attention text
///
///should be outside attention text
void testFunc() {};
不要在文档块中留下空白行,而是将它们放在一起。注意命令以空行结束,但该空行应该是文档块的一部分(即空白行本身就是///
)。
或者,您可以使用/** */
样式的评论,然后编写
/** this is a function
@attention attention text
should be outside attention text
*/
void testFunc() {};
答案 1 :(得分:2)
作者与宏相关联,而不是整个文件。
如果您希望它与文件相关联,那么您应该将其与文件相关联。这意味着在与@file
相同的块中使用@author
说明符(显然在它之前)。