Doxygen — это де-факто стандартный инструмент для создания документации из аннотированных источников C++, но он также поддерживает другие популярные языки программирования, такие как C, Objective-C, C#, PHP, Java, Python, IDL (разновидности Corba, Microsoft и UNO/OpenOffice). ), Fortran, VHDL и в некоторой степени D.
Doxygen может помочь вам тремя способами:
- Он может генерировать интерактивный браузер документации (в HTML) и/или автономное справочное руководство (в LaTeX) из набора задокументированных исходных файлов. Существует также поддержка создания выходных данных в формате RTF (MS-Word), PostScript, PDF с гиперссылками, сжатом HTML и справочных страницах Unix. Документация извлекается непосредственно из исходников, что значительно упрощает обеспечение согласованности документации с исходным кодом.
- Вы можете настроить doxygen для извлечения структуры кxc0
- ода из недокументированных исходных файлов. Это очень полезно, чтобы быстро ориентироваться в больших дистрибутивах с исходным кодом. Doxygen также может визуализировать отношения между различными элементами с помощью графов зависимостей, диаграмм наследования и диаграмм сотрудничества, которые генерируются автоматически.
- Вы также можете использовать doxygen для создания обычной документации.
Исполняемый файл doxygen — это основная программа, которая анализирует исходники и создает документацию.
При желании можно использовать doxywizard, который представляет собой графический интерфейс для редактирования файла конфигурации, используемого doxygen, и для запуска doxygen в графической среде. Для Mac OS X doxywizard запускается щелчком по значку приложения doxygen.
