Руководство по Doxygen

Это руководство разделено на три части, каждая из которых разделена на несколько секций.

Первая часть составляет руководство пользователя:

• В секции Инсталяция обсуждается как скачать, скомпилировать и установить doxygen на Вашу платформу.
• Секция Быстрый старт расскажет как быстро сгенерировать Вашу первую документацию.
• Секция Документирование кода демонстрирует различные способы документирования кода.
• Секция Списки покажет различные способы создания списков.
• Секция Группировка показывает, как объединять информацию.
• Секция Включение формул показывает как вставить формулы в документацию.
• Секция Графы и диаграммы описывает диаграммы и графы, которые может генерировать doxygen.
• Секция Предварительная подготовка объясняет, как doxygen ведет себя с макроопределениями.
• Секция Генерация автоматических ссылок показывает, как поместить ссылки на файлы, классы и члены в документацию.
• Секция Выходные форматы показывает, как генерировать выходные форматы, которые поддерживает doxygen.
• Секция Настройка вывода объясняет, как Вы можете настроить вывод генерируемый doxygen.
• Секция Настраиваемые команды показывает, как определять и использовать настраиваемые команды в Ваших комментариях.
• Секция Связь с внешней документацией объясняет, как doxygen может создавать ссылки на внешнюю документацию.
• Секция Часто задаваемые вопросы дает ответы на часто задаваемые вопросы.
• Секция Поиск неисправностей рассказывает Вам, что нужно сделать для решения возникших проблем.

Вторая часть составляет справочник:

• Секция Особенности представляют краткий обзор того, что может сделать doxygen.
• Секция Истоия Doxygen показывает то, что изменилось во время разработки doxygen и что все еще должно быть сделано.
• Секция Использование Doxygen показывает, как использовать Doxygen.
• Секция Использование Doxytag показывает, как использовать Doxytag.
• Секция Использование Doxywizard показывает, как использовать Doxywizard.
• Секция Использование Installdox показывает, как использовать Installdox скрипт, который генерирует doxygen, если Вы используете файл тегов.
• Секция Настройка показывает, как настроить doxygen, чтобы получить нужную документацию.
• Секция Специальные команды показывают краткий обзор специальных команд, которые могут использоваться в документации.
• Секция Команды HTML показывают краткий обзор команд HTML, которые могут использоваться в документации.
• Секция Команды XML делает краткий обзор команд XML в стиле C#, которые могут использоваться в документации.

Третья часть предоставляет информацию для разработчиков:

• Секция Внутреннее устройство Doxygen дает подробное оприсание внутреннего устройства Doxygen.
• Секция Выходной формат документации Perl Module показывает, как использовать вывод PerlMod.
• Секция Интернационализация объясняет, как добавить поддержку новых языков вывода.