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

Question

I want to include folder in doxygen documentation.

I have tried \page and \include but it hasn't worked, does anyone know how to do it? Here is the tree :

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

Answer 1

To add to the comments on your question, the \page command will add pages into your documentation that you have manually written. I.e. if a source file contains a \page declaration it will add the contents to the documentation index. You can add extra help here, such as:

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

The \include command will include a copy of a file as a source code block.

I think you're actually asking how you get Doxygen to add multiple source directories. As long as the recursive setting is YES, which is not the default, it should work fine for your structure if you've set the root folder as the Doxygen input.

RECURSIVE              = YES

If you haven't, you can add different folders like this, with paths relative to the Doxyfile file.

#---------------------------------------------------------------------------
# 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