Doxygen — система документирования для C++, C, Java, Objective-C, Python, IDL (Corba и Microsoft flavors), Fortran, VHDL, PHP, C#, и до некоторой степени D.

Она может помочь Вам в трех случаях:

  1. Система может генерировать документацию как для просмотра он-лайн (в HTML) так и в виде справочного описания (в ) из набора исходных файлов. Также возможен вывод в форматы: RTF (MS Word), PostScript, hyperlinked PDF, compressed HTML и в страницы помощи Unix man. Документация формируется непосредственно из исходников, что делает более легким сохранение соответствия документации с исходными текстами.
  2. Вы можете сконфигурировать doxygen, чтобы извлечь структуру кода из неописанных исходных файлов. Это очень полезно для быстрой ориентации в распространяемых больших исходных текстах. Вы можете также визуализировать отношения между различными элементами посредством включения графов зависимости, диаграмм наследования и диаграмм взаимоотношения, которые генерируются автоматически.Вы можете даже ‘нарушить режим эксплуатации’ doxygen для того, чтобы создать нормальную документацию (поскольку я сделал для этого руководства).
  3. Doxygen разработан под Linux и Mac OS X, но является переносимым. В результате он выполняется также на большинстве других разновидностях Unix. Кроме того, доступны версии для выполнения под ОС Windows.

Лицензия Doxygen

 Copyright © 1997-2009 by Dimitri van Heesch.

Разрешено использовать, копировать, изменять и распространять это программное обеспечение и его документацию в соответствии с GNU General Public License. Никакие претензии о пригодности этого программного обеспечения для различных целей не принимаются. Оно распространяется «как есть» без явной или неявной гарантии. Более подробно смотри GNU General Public License. Документы, созданные doxygen, являются производным продуктом, полученным от его использования; они не затронуты этой лицензией.

Примеры пользователей

Doxygen поддерживает много выходных форматов, где HTML — самый популярный. Я собрал некоторые хорошие примеры реальных проектов, используя doxygen.

Они — часть большего списка проектов, использующих doxygen. Если Вы знаете другие проекты, сообщите мне, и я добавлю их.

Планы на будущее

 Хотя doxygen уже успешно используется большим количеством пользователей, всегда есть возможности для усовершенствования. Поэтому, я составил список требуемых/желаемых возможностей и/или требуемых улучшений.

Благодарности

 Спасибо

  • Malte Zöckler and Roland Wunderling, authors of DOC++. The first version of doxygen borrowed some code of an old version of DOC++. Although I have rewritten practically all code since then, DOC++ has still given me a good start in writing doxygen.
  • All people at Qt Software, for creating a beautiful GUI Toolkit (which is very useful as a Windows/Unix platform abstraction layer 🙂
  • My brother Frank for rendering the logos.
  • Harm van der Heijden for adding HTML help support.
  • Wouter Slegers of Your Creative Solutions for registering the www.doxygen.org domain.
  • Parker Waechter for adding the RTF output generator.
  • Joerg Baumann, for adding conditional documentation blocks, PDF links, and the configuration generator.
  • Tim Mensch for adding the todo command.
  • Christian Hammond for redesigning the web-site.
  • Ken Wong for providing the HTML tree view code.
  • Talin for adding support for C# style comments with XML markup.
  • Petr Prikryl for coordinating the internationalisation support. All language maintainers for providing translations into many languages.
  • The band Porcupine Tree for providing hours of great music to listen to while coding.
  • many, many others for suggestions, patches and bug reports.