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

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

13 голосов
/ 14 июня 2011

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

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

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

1 Ответ

21 голосов
/ 23 июля 2011

Чтобы добавить комментарии к вашему вопросу, команда \ 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
...