Как включить папку в документацию doxygen?

Я хочу включить папку в документацию doxygen.

Я пробовал page и include, но это не сработало, кто-нибудь знает, как это сделать? Вот дерево :

+root
-+controllers
--- category.php
-+models
--- categories.php
- mainpage.php
13
documentation doxygen php

1 ответов

чтобы добавить комментарии к вашему вопросу, команда \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 для добавления нескольких исходных каталогов. Пока рекурсивный параметр ДА, который не является значением по умолчанию, он должен отлично работать для вашей структуры, если вы установили корневую папку в качестве входных данных 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
20