Doxygen - Ini作为文本?

时间:2013-11-26 10:29:29

标签: documentation doxygen ini


我开始用doxygen进行编程,就它而言似乎非常简单和乐于助人! 只有一个文件让我头疼,我的config.ini。 此文件有不同的注释,标准等。 我想将其加载为“代码”,因此页面不会被解释。

我怎样才能做到这一点?

以下不起作用:
; /// @file config.ini
; /// @code
设置1
设置2
setting3
; /// @endcode

2 个答案:

答案 0 :(得分:0)

你的问题有点不清楚,但我从你的问题中假设你想要在文档中看到.ini文件的内容。

对于我认为您需要的内容,我建议您使用@verbatim而不是@code

如果您没有看到任何内容,请检查.ini是否在doxygen将解析的文件扩展名列表中?这是doxyfile中的一个设置。

答案 1 :(得分:0)

你可以按照以下方式做你想做的事:

定义包含.ini文件的页面,例如test.dox,如下所示:

/** @page test_ini test.ini
 *  This is the configuration file:
 *  @verbinclude test.ini
 */

然后将doxygen的配置文件中的EXAMPLE_PATH设置为包含test.ini的目录,并且不要在FILE_PATTERNS中包含.ini文件(因此请使用默认值)。