Doxygen不会处理main.cpp

时间:2010-10-21 18:08:34

标签: doxygen mainclass doxywizard

所以我是使用Doxygen的新手,我能够让它顺利运作。我能够记录我的类和结构,并完美地生成HTML文件。我遇到的问题是它不会解析我的main.cpp文件。所有的类和结构都有自己的.h和.cpp文件,它们处理得很好。如何让Doxygen为main.cpp制作文档?它没有.h文件,因为这是程序开始和结束的地方。我甚至都不知道要把什么放在主文件的.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)
{
}

3 个答案:

答案 0 :(得分:6)

我把它放在main.cpp的顶部并且它有效。去图。

/**
@file main.cpp
*/

答案 1 :(得分:2)

如果INPUTFILE_PATTERNS为空,则应在当前目录中搜索* .cpp文件(以及许多其他模式)。 (来自doxygen manual。)

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

  1. main.cpp不在当前目录中。要排除这种情况,请确保您从 配置文件和main.cpp所在的目录中运行doxygen。
  2. main.cpp文档中存在语法错误。这些可能很难发现,因为当遇到错误时doxygen通常不会中止 - 而是它只是向前跳过。如果这是问题,请在逐行生成文档时梳理doxygen的输出。
  3. 如果这些想法都没有解决您的问题,我们可能需要更多信息。输出ls -R,输出doxygen运行等等。祝你好运!

答案 2 :(得分:1)

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

  

重要:全局函数,变量,typedef的文档,   和枚举只会包含在   如果它们所在的文件是输出   记录在案。

你去吧!