使用doxygen .dox文件

Question

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

• 文档文件，如.dox文件。
• src/ -源文件

我在doxygen.config文件中的设置是：

INPUT                  = ../ .

FILE_PATTERNS          = *.h *.dox *.dxx

当我运行doxygen (doxygen doxygen.config)时，它正确地从.h文件生成所有文档，但是它不能正确地生成主页。我在doc文件夹中有一个名为doc的文件，其中有一个命令\mainpage Documentation Index和一堆文本，但是doxygen没有使用它来生成主页。

我做错了什么？

Answer 1

这种情况(至少)有两个可能的原因：

1. 您没有将/doc目录包括在INPUT列表中。试着修改这个 输入= ../。../医生 你是想写../doc而不是../吗？我猜您的doxygen.config文件在您的src目录中。如果不是这样的话，你能在这个问题上说明清楚吗？
2. .dox要求您的文档文件(您的/** ... */文件)是纯文本，您的文本被DO2 C++注释(即/** ... */)包裹。

Answer 2

如果不知道doxygen.config的位置，并且在INPUT中使用相对路径，就很难确定导致这种情况的原因，但是，由于您要查找的文件位于并行目录中，所以doxygen可能不会递归地搜索您的文件。您可能需要确认RECURSIVE设置为YES in doxygen.config。