如何在doxygen文档中包含文件夹?

时间:2011-06-14 07:44:29

标签: php documentation doxygen

我想在doxygen文档中包含文件夹。

我试过\ page和\ include但它没有用,有谁知道怎么做?这是树:

+root
-+controllers
--- category.php
-+models
--- categories.php
- mainpage.php

1 个答案:

答案 0 :(得分:21)

要添加到您的问题的评论,\ page命令会将页面添加到您手动编写的文档中。即如果源文件包含\ page声明,它会将内容添加到文档索引中。您可以在此处添加额外帮助,例如:

/*! \page overviewpage Architecture Overview
 *
 * \section memorymanagement Memory Management
 *
 * Some writing you want to appear as a help page in the documentation here.
 */

\ include命令将包含一个文件副本作为源代码块。

我想你实际上是在问你如何让Doxygen添加多个源目录。只要递归设置为YES(这不是默认设置),如果您将根文件夹设置为Doxygen输入,它应该适用于您的结构。

RECURSIVE              = YES

如果还没有,可以使用相对于Doxyfile文件的路径添加这样的不同文件夹。

#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------

# The INPUT tag can be used to specify the files and/or directories that contain 
# documented source files. You may enter file names like "myfile.cpp" or 
# directories like "/usr/src/myproject". Separate the files or directories 
# with spaces.

INPUT                  = src test/src