如何在 doxygen 文档中包含文件夹？答案

【问题标题】：How to include folder in doxygen documentation?如何在 doxygen 文档中包含文件夹？
【发布时间】：2011-09-14 11:52:37
【问题描述】：

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

我尝试了\page 和\include，但没有成功，有人知道怎么做吗？这是树：

+根 -+控制器 --- 类别.php -+型号 --- 类别.php - 主页.php

【问题讨论】：

这个有用吗：comments.gmane.org/gmane.text.doxygen.general/8425 ?
我想知道文件夹包含什么。图片？要记录的课程？要包含的 HTML 文件？
@cweiske 该文件夹包含要记录的类
@Matt Ellen 感谢您的链接:)
@Matt Ellen 我已经尝试过链接上的示例，它出现的页面无法单击，并且在该文件夹中有必须记录的类文件，我已经编辑了我的添加文件夹和文件树的问题。谢谢

标签： php documentation doxygen

【解决方案1】：

要添加到您的问题的 cmets，\page 命令会将页面添加到您手动编写的文档中。 IE。如果源文件包含 \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

【讨论】：