Статья: "Использование Doxygen."

Статья

Версия для печати

Обсудить на форуме

Использование Doxygen.

Автор: Malaja.
Дата написания: 28.04.2009.
Права на статью принадлежат автору и Клубу программистов «Весельчак У».

Содержание.

Вводная
Инсталляция
Комментарии
Конфигурация
Дополнительное описание

Вводная

Эта статья возникла после очередной попытки вспомнить, как оно там конфигурируется, чтобы все работало ;-)

Сам Doxygen представляет собой инструмент для создания онлайн-документации к Вашему любимому и выстраданному коду. Он бесплатен, посему очень любим фирмами.

Инсталляция

Сначала загружаем сам doxygen, затем — графический инструмент graphviz, с помощью которого можно строить диаграммы:

Комментарии

Если мы хотим, чтобы в документации также появлялись наши комментарии, которые стоят в коде, их необходимо помечать таким образом:

Код:

/// сам комментарий

Остальные варианты — см. мануал.

Конфигурация

Теперь в нашей рабочей директории стартуем cmd, в котором набираем:

Код:

doxygen -g <config-file>

Соответственно, вместо <config-file> мы пишем, что сами хотим (так, в моем примере это composTest_doxygen.cfg).

После выполнения этой команды будет создан стандартный конфиг. Для его обработки нам понадобится Doxywizard. Посему стартуем и приступаем к установкам, которые нам необходимы:

Шаг 1.

Шаг 2.

Шаг 3.

Шаг 4.

Шаг 5.

Если хотим увидеть список файлов, директорий и т.д.

Шаг 6. Смотреть дополнительное описание.

Шаг 7.

При включении опции GENERATE_TREEVIEW в документации появляется левая часть.

Шаг 8.

Рассмотрим последствия включения тех или иных тегов:

1. CALL_GRAPH и CALLER_GRAPH: создает схемы вызова функций:

2. COLLABORATION_GRAPH:

3. GRAPHICAL_HIERARCHY:

4. CLASS_DIAGRAMS и CLASS_GRAPH:

5. HAVE_DOT — должно быть включено для создания диаграмм.

6. HIDE_UNDOC_RELATIONS — лучше оставить выключенным.

7. DOT_IMAGE_FORMAT — попробовала установить jpg — не пошло... Оставила png.

8. DOT_PATH — указала место инсталляции графического инструмента.

9. MAX_DOT_GRAPH_DEPTH — в моем случае между установкой 0 или 50 разницы никакой. Но в каждом конкретном случае это надо смотреть самому.

Дополнительное описание

/*! \mainpage OMSp_MBT_ComposTest
 *
 * \section intro_sec Introduction
 *
 * <b>Developer</b>:
 * - имя
 *
 * \section requirements Requirements
 * The application OMSp_MBT_ComposTest.dll requires the following external stuff:
 * - lib1
 * - dll1
 *
 * \section changelog Changelog
 *
 * - February 2009: initial release
 *
 * \section About_sec About this documentation
 *
 * \subsection step1 Location
 *  
 * This documentation can be found on file://dir1/dir2/index.html
 * 
 * \subsection step2 Updating
 * 
 * <b>Requirements</b>
 * - Installed <b><i>doxygen</i></b> package (from http://www.stack.nl/~dimitri/doxygen)
 * - Optional: Installed <b><i>graphviz</i></b> tool for diagrams (from http://www.graphviz.org) 
 *   <br><sup><b>Note:</b> you have add the <b>bin</b> path of the installation to the 
 *   <tt>PATH</tt> environment variable</sup>
 *
 * <b>Generating</b>
 *
 * - go to source location <b> dir1\project_dir </b>
 * - open a cmd window
 * - type <tt>doxygen наш_конфиг_файл.cfg </tt>
 *
 * <b>Configuration files</b>
 * - <tt> наш_конфиг_файл.cfg </tt> (text file; general configuration of input files and output)
 * - <tt> имя_этого_файла.txt</tt> (text file for processing this Main Page)
 */

Все, что выделено голубым цветом, надо заменить на Ваши конкретные данные.

Версия для печати

Обсудить на форуме