Doxygen использует конфигурационный файл для определения всех своих настроек. Каждому проекту требуется свой собственный конфигурационный файл. Проект может состоять из единственного исходного файла, а может также все дерево исходников, которое просмотрено рекурсивно.
Чтобы упростить создание конфигурационного файла, doxygen может
сделать для Выс шаблон конфигурационного файла. Чтобы сделать это,
вызовите doxygen из командной строки с опцией -g:
doxygen -g <config-file>
где <config-file> — имя конфигурационного файла. Если Вы опустите имя файла, будет создан файл с именем Doxyfile.
Если файл с таким именем уже существует, doxygen переименует его в .bak
перед генерацией шаблона конфигурации. Если Вы используете - (то есть знак минус) вместо имени файла, тогда doxygen попытается прочитать конфигурационный файл из стандартного ввода (stdin), который может быть полезным для создания сценария.
Конфигурационный файл имеет формат , который похож на (simple) Makefile. Он состоит нескольких назначений (тегов) формы:
TAGNAME = VALUE или
TAGNAME = VALUE1 VALUE2 ...
Вы, вероятно, можете оставить значения большинства тегов в сгенерированном шаблоне конфигурационного файла по умолчанию. Смотрите секцию Configuration для получения дополнительной информации о конфигурационном файле.
Если Вы не желаете редактировать конфигурационный файл в текстовом редакторе, Вы можете ознакомиться с doxywizard, который является GUI интерфейсом который может создавать, читать и записывать конфигурационный файл doxygen, и позволяет установку опций конфигурации путем ввода их значений через диалоги.
For a small project consisting of a few C and/or C++ source and header files, you can leave INPUT tag empty and doxygen will search for sources in the current directory.
Если у вас большой проект, состоящий из катадлога или дерева исходников, Вы должны назначить корневую директорию или директории в теге INPUT, и добавить один или несколько шаблонов файлов к тегу FILE_PATTERNS (например *.cpp *.h). Только файлы, которые соответствуют одному из шаблонов, будут анализироваться (если шаблоны будут опущены, будет использоваться список расширений исходников). Для рекурсивного разбора терева исходников, Вы должны установить тег RECURSIVE в YES. Кроме того Вы можете использовать теги EXCLUDE и EXCLUDE_PATTERNS для тонкой настройки списка файлов, которые будуть проанализированы. Например, чтобы пропустить все директории test в дереве исходников, Вам нужно использовать:
EXCLUDE_PATTERNS = */test/*
Doxygen смотрит на расширение файла, чтобы решить как анализировать файл. Если у файла расширение .idl или .odl, то они обрабатываются как IDL файл. Если у него расширение .java, то он обрабатывается как написаннтый на Java. Файлы заканчивающиеся на .cs обрабатываются как C# файлы, а для расширения .py выбирается синтаксический анализатор Python. Наконец, файлвы с расширениями .php, .php4, .inc или .phtml обрабатываются как исходники PHP. Любые другие расширения анализируются как C/C++ файл, где файлы заканчивающиеся на .m обрабатываются как исходные файлы на Objective-C.
Если Вы начали использовать doxygen для существующего проекта (таким образом, без документации о которой doxygen знает), Вы можете еще получить представление о структуре и как ,eltn dsukzltnm результат документирования. Xnj,s nfr cltkfnm? Ds ljk;ys ecnfyjdbnm ntu EXTRACT_ALL в конфигурационном файле в YES. Тогда doxygen будет считать, что Выш иисходники задокументированы. Пожалуйста заметьте, что ка следствие, недокментированные элементы не будут сгенерироанны, пока EXTRACT_ALL устновлено в YES.
Чтобы проанализировать существующую часть программного обеспечения, полезно создавать перекрестные ссылки на (документированные) объекты с их определением в исходных фалйхt. Doxygen сгенерирует такие перекрестные ссылки, если Вы установите тег SOURCE_BROWSER в YES. Можно также включать источники непосредственно в документацию установкой INLINE_SOURCES в YES (это может быть удобно, например, для обзора кода).