Doxygen

Материал из Википедии — свободной энциклопедии

Перейти к: навигация, поиск
Doxygen
Изображение:Doxygen.png
Тип Генератор документации
Разработчик Dimitri van Heesch
ОС GNU/Linux, Mac OS X, Solaris, Microsoft Windows
Версия 1.5.8 — 4 марта 2009
Лицензия GNU GPL
Сайт http://www.doxygen.org

Doxygen — это кроссплатформенная система документирования исходных текстов, которая поддерживает C++, Си, Objective-C, Java, IDL,PHP, C#, Фортран, VHDL и, частично, D.

Doxygen генерирует документацию на основе набора исходных текстов и также может быть настроен для извлечения структуры программы из недокументированных исходных кодов. Возможно составление графов зависимостей программных объектов, диаграмм классов и исходных кодов с гиперссылками.

Doxygen имеет встроенную поддержку генерации документации в формате HTML, \mathrm{L\!\!^{{}_{\scriptstyle A}} \!\!\!\!\!\;\; T\!_{\displaystyle E} \! X}, man, RTF и XML. Также вывод может быть легко сконвертирован в CHM, PostScript, PDF.

Для html-представления документации, размещаемого на web-серверах, существует удобный способ организации поиска (при помощи создаваемого Doxygen'ом PHP-модуля) и ссылок на внешнюю документацию.

Doxygen используется многими проектами, в том числе KDE, Pidgin, Torque Game Engine, AbiWord, Mozilla, FOX toolkit, Crystal Space. Есть встроенная поддержка в KDevelop.

Автором программы является голландец Димитри ван Хееш (Dimitri van Heesch).

Doxygen - консольная программа в духе классической Unix, написанная с использованием кроссплатформенной библиотеки Qt версии 3. Она работает подобно компилятору, анализируя исходные тексты и создавая документацию. Параметры создания документации читаются из конфигурационного файла, имеющего простой текстовый формат.

Для упрощения манипуляций с конфигурационным файлом (а он содержит довольно много настроек), существует несколько утилит с графическим интерфейсом. Одна из них, doxywizard, реализованная с использованием Qt версии 3, поставляется вместе с Doxygen.

Сравнительно недавно (лето 2008 года) вышла альтернативная программа Doxygate (http://sourceforge.net/projects/doxygate), которая основана на Qt версии 4.

[править] Ссылки

[править] См. также

Источник — «http://ru.wikipedia.org/wiki/Doxygen»