doxygen/**样式在启用markdown的情况下创建虚假代码块



我们有一个大量使用Doxygen的大型C++项目。当Doxygen添加markdown支持时,我们生成的文档突然出现了不需要的"装箱"代码块,其中包含许多文档化类和成员的第一个注释行。禁用降价支持解决了这个问题,但我们希望能够使用降价。

问题显然是我们对Doxygen注释使用了/**样式。为了简洁,我们在同一行开始评论,特别是对于简短的评论,我们不缩进注释的其余部分。我猜Doxygen将其作为缩进行发送到markdown,所以markdown将其放在代码块中。像这样的评论很好:

/** This a short comment (works). */

但像这样的评论最终会把第一行当作放在代码块中:

/** This is a somewhat longer comment that ended up
being wrapped to a second line (first line treated as code). */

通过以下任一方式重新格式化可修复问题:

/** This is a somewhat longer comment that ended up
    being wrapped to a second line (works). */
/** 
This is a somewhat longer comment that ended up
being wrapped to a second line (works). */

我们在上面的紧凑形式中记录了数千个类和成员,希望能够在不改变这种风格的情况下启用markdown。有没有办法让Doxygen不生成这些不需要的代码块?

我使用的是1.8.5 Doxygen。

我看到了您的问题,我预计用户真正想要用代码块开始注释的情况非常罕见。

在doxygen中改变这一点其实很容易。如果您可以在此处将其作为错误报告进行归档:https://bugzilla.gnome.org/enter_bug.cgi?product=doxygen然后我会为这个bug向GitHub推送一个修复程序。

最新更新