DoxygenOrg.Ru

Перевод материалов сайта Doxygen.Org

Font Size

SCREEN

Profile

Layout

Direction

Menu Style

Cpanel

Компилирование из исходников в Unix

После того, как Вы загрузили исходный код, Вам, для создания исполняемых файлов, нужно следующее:

  • GNUпрограммы flex, bison, make и strip
  • Чтобы сгенерировать Makefile для Вашей платформы, Вам потребуется perl.
  • Конфигурационный скрипт использует стандатрные утилиты Unix такие как: sed, date, find, uname, mv, cp, cat, echo, tr, cd и rm.

Чтобы полностью воспользоваться функционалом doxygen должны быть установлены следующие дополнительные инструментальные средства.

  • Qt Software's GUI toolkit Qtверсии 3.3 или выше. Он необходим для построения GUI интерфейса doxywizard.
  • Дистрибутив $mbox{LaTeX}$: например teTeX 1.0. Он необходим для генерации LaTeX, Postscript и PDF выходных форматов.the Graph visualization toolkit версии 1.8.10 или выше. Необходим для включения графов зависимости, наглядных графов наследования и графов взаимодействия. Если Вы компилируете graphviz самостоятельно, убедитесь, что вы включили поддержку FreeType (которая включает библиотеки FreeType и заголовочные файлы), иначе графы на будут изображать правильные тексторые надписи.
  • Для формул или если Вы не хотите использовать pdflatex, необходим интерпретатор Ghostscript. Вы можете найти его на www.ghostscript.com.
  • Чтобы генерировать собственную doxygen документацию, нужен Python, Вы можете найти его на www.python.org.

Для компиляции нужно выполнить следующие шаги:

  1. Распакуйте архив, если Вы это еще не сделали:

         gunzip doxygen-$VERSION.src.tar.gz    # расжать архив     tar xf doxygen-$VERSION.src.tar       # распаковать его 
  2. Запустите конфигурационный скрипт:

         sh ./configure 

    Скрипт пытается определить платформу, которую Вы используете, утилиту make (которая должна быть GNU make) и интерпретатор perl. Он сообщит о том, что нашел.

    Отключить автопределение платформы и компилятора можно запустив конфигурирование следующим образом:

         configure --platform platform-type 

    Смотрите в файле PLATFORMS список возможных настроек платформы.

    Если у Вас установлен Qt-3.3.x и Вы хотите построить GUI интерфейс, запустите конфигурационный скрипт с параметром --with-doxywizard:

         configure --with-doxywizard 

    Для краткого обзора других конфигурационных опций используйте

         configure --help 

     

  3. Скомпилируйте программу, запустив make:

         make 

    Программа должна компилироваться без проблем и три (скорее всего два, прим. переводчика) двоичных файла (doxygen и doxytag) должны быть доступны в каталоге bin дистрибутива.

     

  4. Опционально: Сгенерируйте пользовательскую документацию.

         make docs  

    Позволит Doxygen сгенерировать HTML документацию.

    Каталог HTML дистрибутива будет содержать html документацию (только укажите HTML браузеру файл index.html в директории html). Для этого Вым потребуется интерпретатор python.

     

  5. Опционально: Сгенерируйте PDF версию руководства (Вым потребуется для этого pdflatex, makeindex и egrep).

         make pdf 

    PDF руководство doxygen_manual.pdf будет расположено в каталоге latex дистрибутива. Просмотр и печать только через Acrobat Reader.