c++ - Doxygen - 如何在没有换行符的情况下结束注意力 block

Question

基本上我想在注意部分之后继续常规文本的流动。如果我留下一个换行符，doxygen 将不会将换行符之前的文本关联为该项目的文档。有没有一种通用的方法来结束任意部分，例如 @attention，而不会将整个部分(即 @attention)放在另一个 block 中并终止它。

编辑

例如给定

///this is a function
///@attention attention text

///should be outside attention text
void testFunc() {};

doxygen 输出如下:

void testFunc ()

should be outside attention text

this is a function

Attention:
attention text

即文本的顺序已更改。

更新

另一个类似的问题:在文件的开头我有:

///@author Somebody
///

#define MY_MACRO printf

作者与宏关联，而不是整个文件。如果我在 @author 之后附加一个空注释行，我会得到相同的结果

一般来说，如果没有像 @endcode 这样的显式关闭宏，是否有一种通用的方法来结束 doxygen 中的 block 。

Answer 1

试试这个:

///this is a function
///@attention attention text
///
///should be outside attention text
void testFunc() {};

与其在文档 block 中留下空行，不如将它们放在一起。注意命令以空行结尾，但该空行应该是文档 block 的一部分(即空行本身表示 ///)。

或者，你可以使用 /** */ 风格的评论，然后你会写

/** this is a function
    @attention attention text

    should be outside attention text
*/
void testFunc() {};