【问题标题】:Issue with doxygen .dox filesdoxygen .dox 文件的问题
【发布时间】:2012-08-25 19:55:55
【问题描述】:

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

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

  • src/ - 源文件

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

INPUT                  = ../ .

FILE_PATTERNS          = *.h *.dox *.dxx

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

我做错了什么?

【问题讨论】:

    标签: doxygen


    【解决方案1】:

    这有(至少)两个可能的原因:

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

      INPUT = ../ . ../doc
      

      您的意思是写../doc 而不是../?我猜你的doxygen.config 文件在你的src 目录中。如果不是这种情况,您能否在问题中说明这一点。

    2. Doxygen 要求您的文档文件(您的 .dox 文件)是纯文本,并且您的文本使用 Doxygen C++ cmets(即 /** ... */)包裹。

    【讨论】:

    • 我发现了问题所在。 c++ 注释没有被 */ 关闭。感谢您的帮助!
    【解决方案2】:

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

    【讨论】:

    • RECURSIVE 设置为 YES,doxygen.config 位于 doc 文件夹中,这是我运行 doxygen 的文件夹。
    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2013-06-04
    • 2020-10-05
    • 2013-05-01
    • 2019-05-11
    • 2013-05-22
    • 2011-10-10
    • 1970-01-01
    相关资源
    最近更新 更多