如何制作Doxygen复制“* /”而不进行处理

时间:2012-04-16 09:21:20

标签: doxygen

我有一个问题。

我在Doxygen文档中有mainpage,其中,结束注释分隔符“* /”在注释中,这就是Doxygen停止生成页面的地方,因为它认为这是它的结束。如何在不加工的情况下将Doxygen复制?

它看起来像这样:

/**
@mainpage
The end comment delimiter in Doxygen is */
... bla bla bla...
**/

在这里,我应该提一下,我已经尝试过@code@verbatim,但这些正在制作代码块,我不想这样做。

提前致谢!

2 个答案:

答案 0 :(得分:2)

这也是一个黑客,但对于HTML和LaTeX输出,你可以使用

/**
@mainpage
The end comment delimiter in Doxygen is \endcomment
... bla bla bla...
**/

配置文件中包含以下别名定义:

ALIASES = endcomment="\htmlonly*/\endhtmlonly\latexonly$\ast$/\endlatexonly"

答案 1 :(得分:1)

以下似乎有效(至少对于C#):

/**
@mainpage
The end comment delimiter in Doxygen is
**/
/// */ \n
/**
... bla bla bla...
**/

///继续上一条评论,但由于它不是以/**开头,因此*/不会被视为评论的结尾。 \n是将... bla bla bla...放在新行上。

修改

这适用于程序中的构造的doxygen注释(如类或枚举),但不适用于@mainpage部分。

第二次编辑

仅使用单行注释,并设置MULTILINE_CPP_IS_BRIEF标志现在似乎适用于mainpage部分

/// @mainpage
/// The end comment delimiter in Doxygen is */
/// ... bla bla bla...

这显然意味着您需要使用///评论样式,至少在主页面部分,但这似乎是唯一的选择(除非* /是可行的选项:P )