Doxygen-1.4.1

Введение в Doxygen

Пакет Doxygen содержит систему документации для C++, C, Java, Objective-C, Corba IDL и для некоторых расширений PHP, C# и D. Он полезен для генерирования HTML документации и/или локальной документации из документированных исходных файлов. Так же есть поддержка для генерации вывода в RTF, PostScript, гиперссылочного PDF, сжатого HTML и Unix man страниц. Документация извлекается прямо из исходников.

Вы можете так же настроить Doxygen для извлечения структуры кода из недокументированных исходных текстов. Это очень полезно для быстрого нахождения вашего пути в больших дистрибутивах исходников. При использовании совместно с GraphViz, вы так же можете визуализировать зависимости между различными элементами при помощи включения графиков зависимостей, диаграмм наследственности и сотрудничества, которые генерируются автоматически.

Информация о пакете

  • Адрес (HTTP):

  • Адрес (FTP): ftp://ftp.stack.nl/pub/users/dimitri/doxygen-1.4.1.src.tar.gz

  • Контрольная сумма: b0ea863bb3ccc757264f784a36519ddb

  • Размер: 2.7 MB

  • Требуемое дисковое пространство: 48.2 MB

  • Расчетное время сборки: 1.77 SBU (включая сборку документации)

Зависимости Doxygen

Установка Doxygen

Установим Doxygen запуском следующих команд:

rm src/unistd.h && ./configure --prefix /usr --docdir /usr/share/doc && make

А теперь, как пользователь root:

make install

Если вы захотите сгенерировать и установить документацию, убедитесь, что установлены пакеты Python, TeX и Graphviz, затем замените следующими командами для make install команды выше:

make docs && make pdf && install -d -m755 /usr/share/doc/doxygen/src && install -m644 src/translator{,_adapter,_en}.h \ /usr/share/doc/doxygen/src && install -m644 VERSION /usr/share/doc/doxygen && make install_docs

Описание команд

rm src/unistd.h: Есть ошибка в Flex-2.5.31, которая означает, что make использует этот файл вместо версии, установленной в системе. Удаление этого файла позволит собрать элементы GUI успешно.

--with-doxywizard: Используйте этот параметр, если у вас установлен Qt и вы хотите собрать GUI оболочку.

make docs: Эта команда соберет HTML документацию.

make pdf: Эта команда соберет PDF версию документации для Doxygen.

install ...: Эти команды установят некоторые файлы, требуемые для установки документации.

Замечание: Для документации на языках, отличных от английского, замените “_en” на код страны вашей локали.

make install_docs: Эта команда установит бинарники и документацию.

Содержание

Установленные программы: doxygen, doxytag и doxywizard
Установленные директории: /usr/share/doc/doxygen

Короткое описание

doxygen

утилита командной строки, используемая для генерации временных файлов конфигурации, а затем генерации документации на основе этих файлов. Используйте doxygen --help для получения параметров командной строки.

doxytag

используется для генерации таг-файла и/или индекса поиска для набора HTML файлов.

doxywizard

GUI оболочка для конфигурации и запуска doxygen.

Последнее обновление 2005-02-08 19:52:39 -0700