RussianLDP Рейтинг@Mail.ru
WebMoney: 
WMZ Z294115950220 
WMR R409981405661 
WME E134003968233 
YandexMoney: 
41001198119846 
E-gold:
5128052

Beyond Linux From Scratch. Версия 6.0

Глава 12. Программирование

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, Вы также можете визуализировать зависимости между различными элементами при помощи включения графиков зависимостей, диаграмм наследственности и сотрудничества, которые генерируются автоматически.

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

  • Адрес (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

Опционально

Qt-3.3.3, Python-2.4, TeX-2.0.2, AFPL Ghostscript-8.14 или ESP Ghostscript-7.07.1 и GraphViz.

Установка 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.

Поиск

 

Найди своих коллег!