Чтобы сгенерировать документацию, Вам нужно выполнить
doxygen <config-file>
В зависимости от Ваших настроек doxygen будут созданы html, rtf, latex, xml и/или man
каталоги в каталоге выгрузки. Как подсказывают названия, эти
каталоги содержат сгенерированную документацию в HTML, RTF, , XML и Unix-Man page форматах.
По умолчанию, каталог выгрузки находится в том же каталоге из которого запущен doxygen. Корневой каталог, в который происходит выгрузка, может быть изменен с помощью тега OUTPUT_DIRECTORY. Формат конкретного каталога в каталоге выгрузки может быть выбран с использованием тегов конфигурационного файла HTML_OUTPUT, RTF_OUTPUT, LATEX_OUTPUT, XML_OUTPUT и MAN_OUTPUT. Если каталога выгрузки не существует, doxygen создаст его для Вас (но он не будет пытаться создать его рекурсивно, как это делаетmkdir -p).
Вывод в HTML
Для того, чтобы просмотреть сгенерированную HTML документацию нужно указать в браузере файл index.html в каталоге html.
Для получения лучших результатов, браузер должен поддерживать таблицу
каскадных стилей (CSS) (Я использую Mozilla, Safari, Konqueror и,
иногда, IE6, чтобы протестировать сгененированный результат).
Некоторые из возможностей раздела(section) HTML (такие как GENERATE_TREEVIEW) требуют браузер, который поддерживает DHTML и Javascript.
Если Вы планируете использовать средства поиска (смотрите SEARCHENGINE), просматривайте вывод HTML через web-сервер поддерживающий PHP (например, apache с установленным модулем PHP).
Вывод в LaTeX
В первую очередь, для получения документацию необходимо скомпилировать компилятором (Я использую последний дистрибутив teTeX). Для упрощения процесса компилирования сгенерированной документации, doxygen записывает Makefile в каталоге latex.
Содержание и цели в Makefile зависят от настройки USE_PDFLATEX. Если она отключена (установлена в NO), то напечатав make к каталоге latex будет сгенерирован dvi файл вызывающий refman.dvi. Этот файл может быть просмотрен с помощью xdvi или сконвертирован в PostScript файл refman.ps, напечатав make ps (это требует dvips).
Чтобы разместить 2 страницы на одной физической странице используйте make ps_2on1.
Результирующий PostScript файл может быть отправлен на PostScript
принтер. Если у Вас нет PostScript принтера, Вы можете попытаться
использовать ghostscript, чтобы сконвертировать PostScript в формат
который понимает Ваш принтер.
Конвертирование в PDF также возможно, если у Вас установлен интерпритатор ghostscript; только напечатайте make pdf (или make pdf_2on1).
Чтобы получить лучший результат для вывода в PDF, Вы можете установить теги PDF_HYPERLINKS и USE_PDFLATEX в YES. В этом случае Makefile будет содержать указание сразу построить refman.pdf.
Вывод в RTF
Doxygen объединяет вывод в RTF в один файл с именем refman.rtf. Этот файл оптимизирован для импорта в Microsoft Word. Для кодирования точной информации испоьзуется поле. Чтобы показать реальное значение, Вам нужно выбрать все (Edit — select all) и затем включить поля (щелкнуть правой кнопкой мыши и выбрать опцию из выпадающего меню).
Вывод в XML
Вывод в XML состоит из структурированной «кучи» информации собранной doxygen. Каждой структуре (class/namespace/file/…) соответствует свой собственный XML файл и существует также индексный файл с именем index.xml.
Также генерируется файл с именем combine.xslt (XSLT script), который может быть использован для объединения всех XML файлов в один файл.
Doxygen также генерирует два файла-схемы XML: index.xsd (для индексного файла) и compound.xsd (для файлов со структурой). Этот файл-схема описывает возможные элементы, их атрибуты и как они структурированы, то есть он описывает грамматику XML файлов и может быть использован для проверки или управления XSLT скриптами.
В дополнениях в каталоге addon/doxmlparser Вы можете найти библиотеку парсер для чтения XML выгрузки предоставленный doxygen (смотрите addon/doxmlparser/include/doxmlintf.h для получения интерфейса к библиотеке)
Вывод в Man page
Сгенерированные страницы man могут быть просмотрены с помощью программы man. Вым нужно убедиться, что директория с man файлами прописана в пути (смотрите переменную окружения MANPATH).
Заметим, что существуют некоторые ограничения возможностей формата man
page, таким образом, некоторая информация (такая как диаграммы класса,
перекрестные ссылки и формулы) будет утеряна.