Question

我正在SLED 10.4（linux）下运行doxygen 1.8.3.1，并且我正在尝试记录包含类似于以下内容的结构的C头文件：

/** Test struct definition */
typedef struct
{
    int member_1;  /**< Single-line detailed description */
    int member_2;  /**< Multi-line detailed description.  Blah
                        blah blah */
} TEST_S;

Doxyfile是由doxygen -g生成的默认值，唯一的变化是我编辑了INPUT标记以指向我的源。

Doxygen根据预期从单行描述生成简单的memdoc段落，但是，多行描述以某种方式被处理，使得第一行被格式化为代码片段。我不知道为什么。生成的实际HTML如下：

<pre class="fragment">  Multi-line detailed description.  Blah
</pre><p> blah blah </p>

为什么Doxygen只产生一个简单的段落？

Answer 1

这似乎是Doxygen在1.8.3.1版本中支持Markdown的错误（我无法用Doxygen 1.8.2重现问题）。如果在配置文件中禁用了markdown支持：

MARKDOWN_SUPPORT = NO

正确呈现页面。

或者，如果您将评论切换为领先的doxygen评论：

/** Multi-line detailed description.  Blah
    blah blah */
int member_2;

或将评论移至以下行：

int member_2;
/**< Multi-line detailed description.  Blah
     blah blah */

它应该正确呈现。

此问题已报告给Doxygen开发小组（https://bugzilla.gnome.org/show_bug.cgi?id=699437）。

成员之后的Doxygen文档 - 故障导致格式化为代码片段？

1 个答案: