Doxygen:代码清单中的每一行都以星号(*)开头

时间:2013-09-02 08:55:00

标签: doxygen code-formatting

我正在使用doxygen为C ++库创建HTML文档。

现在我遇到的问题是,使用\code ... \endcode创建的代码清单会生成列表,其中每行以星号开头。

示例:

Have a look at the following code sample:
\code
int a = 5;
int b = func(a);
\endcode

输出:

Have a look at the following code sample:
* int a = 5;
* int b = func(a);

我无法解释这种行为 - 特别是因为我使用///代替/**来将行标记为doxygen文档。但是这两种格式都会出现问题。 有谁知道如何解决这个问题? (我正在使用doxygen 1.8.5)

2 个答案:

答案 0 :(得分:3)

这确实是1.8.5的不幸回归。

我刚刚修复了GitHub。如果它解决了问题,请告诉我。

答案 1 :(得分:0)

这似乎是一个错误。 Bugzilla entrythis bug也可能是相关的。

我设法通过更改以下代码段来获得解决方法

/// Have a look at the following code sample:
/// \code
/// int a = 5;
/// int b = func(a);
/// \endcode

以下( 请注意,只有两个斜杠 ):

/// Have a look at the following code sample:
// \code   
// int a = 5;
// int b = func(a);
/// \endcode

我对此不满意,因为它需要重新布局所有评论,格式化非常不自然。