6

所以我是使用 Doxygen 的新手,我能够让它顺利工作。我能够记录我的类和结构,它完美地生成了 HTML 文件。我遇到的问题是它不会解析我的 main.cpp 文件。所有的类和结构都有自己的 .h 和 .cpp 文件,它们处理得很好。如何让 Doxygen 制作 main.cpp 的文档?它没有 .h 文件,因为这是程序开始和结束的地方。我什至不知道在 main 的 .h 文件中放什么。我在 Windows 中使用 Doxywizard。

编辑:

我把它放在 main 中,它会生成一个主页:

/**
@mainpage

This is a test application.

@author Alex
@date 10/21/2010
@version 1.0
*/

但是在函数原型所在的文件的更深处,我有这个并且它没有被解析:

/**
@brief Error handler for the PDF writer.

It does nothing. It just has to exist.
*/
void error_handler (HPDF_STATUS   error_no,
                    HPDF_STATUS   detail_no,
                    void         *user_data)
{
}
4

3 回答 3

7

我把它放在 main.cpp 的顶部,它起作用了。去搞清楚。

/**
@file main.cpp
*/
于 2010-10-22T19:33:36.350 回答
2

如果INPUTFILE_PATTERNS为空,它应该在当前目录中搜索 *.cpp 文件(和许多其他模式)。(这来自doxygen 手册。)

由于您是空的,如果您没有获得 main.cpp 文档,我预计会发生以下两种情况之一:

  1. main.cpp 不在当前目录中。要排除这种情况,请确保您在与配置文件和 main.cpp相同的目录中运行 doxygen。
  2. 您的 main.cpp 文档中存在语法错误。这些可能很难发现,因为 doxygen 通常不会在遇到错误时中止 - 相反它只是向前跳过。如果这是问题所在,请在逐行生成文档时梳理 doxygen 的输出。

如果这些想法都不能解决您的问题,我们可能需要更多信息。的输出ls -R,doxygen 运行的输出等。祝你好运!

于 2010-10-21T20:18:43.980 回答
1

我对此做了一些研究......来自doxygen手册

重要提示:全局函数、变量、类型定义和枚举的文档只有在它们所在的文件也被记录时才会包含在输出中。

给你!

于 2011-04-13T18:09:01.660 回答