Подтвердить что ты не робот

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

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

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

+root
-+controllers
--- category.php
-+models
--- categories.php
- mainpage.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 для добавления нескольких исходных каталогов. Пока рекурсивная настройка имеет значение 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