Doxygen
![]() | Ця стаття в процесі редагування певний час. Будь ласка, не редагуйте її, бо Ваші зміни можуть бути втрачені. Якщо ця сторінка не редагувалася кілька днів, будь ласка, приберіть цей шаблон. Це повідомлення призначене для уникнення конфліктів редагування. Останнє редагування зробив користувач Ветер (внесок, журнали) о 07:53 UTC (5597783 хвилини тому). |
Doxygen — кросплатформна система документування вихідних текстів програм, яка підтримує C++, Сі, Objective-C, Python, Java, IDL, PHP, C #, Фортран, VHDL і, частково, D.
Doxygen генерує документацію на основі набору вихідних текстів і також може бути налаштований для вилучення структури програми з недокументованих вихідних кодів. Можливе складання графів залежностей програмних об'єктів, діаграм класів та вихідних кодів з гіперпосиланнями.
Doxygen має вбудовану підтримку генерації документації в форматі HTML, LATEX, man, RTF і XML. Також результати його роботи можуть бути легко сконвертовані в CHM, PostScript, PDF.
Для HTML-представлення документації, що розміщується на web-серверах, існує зручний спосіб організації пошуку (за допомогою створюваного Doxygen'ом PHP-модуля) і посилань на зовнішню документацію.
Doxygen використовується багатьма проектами, в тому числі KDE, Pidgin, Torque Game Engine, AbiWord, Mozilla, FOX toolkit, Crystal Space, Drupal. Є вбудована підтримка в KDevelop.
Doxygen - консольна програма в дусі класичної Unix. Вона працює подібно компілятору, аналізуючи вихідні тексти і створюючи документацію. Параметри створення документації читаються з конфігураційного файлу, що має простий текстовий формат.
Для спрощення маніпуляцій з конфігураційним файлом (а він містить досить багато налаштувань), існує кілька утиліт з графічним інтерфейсом. Одна з них, doxywizard, поставляється разом з Doxygen. Раніше вона була реалізована з використанням Qt версії 3 і мала не дуже зручний інтерфейс. Як альтернатива влітку 2008 року вийшла альтернативна графічна оболонка Doxygate (http://sourceforge.net/projects/doxygate), яка заснована на Qt версії 4. Н незабаром doxywizard був переписаний на Qt версії 4 і проект Doxygate був закритий (див. сторінку проекту на sourceforge.net).