doxygen .dox文件的问题

时间:2012-08-31 01:40:32

标签: doxygen

我正在尝试在我下载源文件的项目的某些源文件上运行doxygen。这些文件位于以下目录中:

  • doc / - 文档文件,例如.dox文件。

  • src / - 源文件

我的doxygen.config文件中的设置是:

INPUT                  = ../ .

FILE_PATTERNS          = *.h *.dox *.dxx

当我运行doxygen(doxygen doxygen.config)时,它会正确生成.h文件中的所有文档,但它不会正确生成主页。我在intro.dox文件夹中有一个标题为doc的文件,其中包含一个命令\mainpage Documentation Index和一堆文本,但是doxygen没有使用它来生成主页面。

我做错了什么?

2 个答案:

答案 0 :(得分:2)

至少有两个可能的原因:

  1. 您未在/doc列表中包含INPUT目录。尝试将其修改为

    INPUT = ../ . ../doc
    

    您的意思是写../doc而不是../吗?我猜您的doxygen.config文件位于src目录中。如果情况并非如此,您可以在问题中明确说明。

  2. Doxygen要求您的文档文件(您的.dox文件)是纯文本,文本包含Doxygen C ++注释(即/** ... */)。

答案 1 :(得分:1)

在不知道doxygen.config的位置,并且因为您在INPUT中使用相对路径,很难确定导致此问题的原因,但是因为您要查找的文件位于并行目录中,doxygen可能不会递归搜索您的文件。您可能需要确认RECURSIVE中的YES设置为doxygen.config