На главную -> MyLDP -> Электронные книги по ОС Linux

---

Beyond Linux From Scratch. Version 2011-12-30
Назад	12. Программирование	Вперед

---

Пакет Doxygen-1.7.5

Знакомимся с пакетом Doxygen

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

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

Известно, что пакет правильно собирается и работает на платформе LFS-7.0.

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

Зависимости пакета Doxygen

Необязательные

Qt-4.7.1 (для doxywizard), Graphviz-2.26.3, Python-2.7.2, TeX Live-20110705,GPL Ghostscript-9.04

Замечания для пользователей: http://wiki.linuxfromscratch.org/blfs/wiki/doxygen

Установка пакета Doxygen

Замечание Если у вас установлены оба пакета Qt-3.3.8d и Qt-4.7.1 и вы добавили параметр --with-doxywizard, то не забудьте установить переменную окружения QTDIR, которая должна указывать на директорий верхнего уровня Qt4.

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

./configure --prefix /usr \
            --docdir /usr/share/doc/doxygen-1.7.5 &&
make

Теперь в роли пользователя root выполните:

make install

Если вы хотите создать и установить документацию к пакету (обратите внимание, что страницы man уже установлены), у вас должны быть установлены пакеты Python, teTeX или TeX Live (для долкументов на HTML) и Ghostscript (для документов на PDF), затем в роли пользователя root выполните следующую команду:

make install_docs

Пояснение команды

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

Конфигурирование пакета Doxygen

Для пакета Doxygen не требуется никакого реального конфигурирования, хотя в случае, если вы хотите использовать расширенные возможности, необходимы три дополнительных пакета. Если вам необходимо использовать возможности, предназначенные для выполнения перевода, у вас должен быть установлен пакет Python-2.7.2. Если вам требуется в документации PDF создавать формулы, то у вас должен быть установлен пакетTeX Live-20110705. Если вам требуется преобразовывать формулы из файлов PostScript в растровые изображения, то у вас должен быть установлен пакет GPL Ghostscript-9.04.

Описание пакета

Установленные программы: doxygen, doxytag и, возможно, doxywizard

Установленные библиотеки: Нет

Установленные директории: /usr/share/doc/doxygen

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

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

Перевод сделан с варианта оригинала, датированного 2011-12-05 22:58:00 +0000

---

Предыдущий раздел:	Оглавление	Следующий раздел:
Пакет DejaGnu-1.5		Пакет Expect-5.45

---

---