Как установить doxygen на linux

Обновлено: 03.07.2024

Documentation system for C, C++, Java, Python and other languages

Install the doxygen-latex package to build LaTeX based documents.

Теги: Разработка программного обеспечения: Литературное программирование, Разработка на C, Разработка на С++, devel::lang:java, devel::lang:objc, Реализовано на: C++, Пользовательский интерфейс: interface::commandline, role::program, Область: Утилита, Цель: Требуется дополнительный тег, Поддерживаемые форматы: works-with-format::html, works-with-format::pdf, works-with-format::postscript, works-with-format::tex, Работает с: Исходный код, Текст

Другие пакеты, относящиеся к doxygen

зависимости

рекомендации

предложения

enhances

sug: doxygen-doc документация по doxygen
sug: doxygen-gui GUI configuration tool for doxygen
sug: doxygen-latex Documentation system for C, C++, Java, Python and other languages
sug: graphviz визуализация графов

Загрузка doxygen

Загрузить для всех доступных архитектур

Архитектура	Версия	Размер пакета	В установленном виде	Файлы
amd64	1.8.13-4+b1	3 971,4 Кб	15 856,0 Кб	[список файлов]
arm64	1.8.13-4+b1	3 615,3 Кб	15 648,0 Кб	[список файлов]
armel	1.8.13-4+b1	3 468,9 Кб	14 075,0 Кб	[список файлов]
armhf	1.8.13-4+b1	3 567,8 Кб	11 975,0 Кб	[список файлов]
i386	1.8.13-4+b1	4 003,1 Кб	15 849,0 Кб	[список файлов]
mips	1.8.13-4+b1	3 420,9 Кб	17 587,0 Кб	[список файлов]
mips64el	1.8.13-4+b1	3 566,3 Кб	19 165,0 Кб	[список файлов]
mipsel	1.8.13-4+b1	3 487,0 Кб	17 587,0 Кб	[список файлов]
ppc64el	1.8.13-4+b1	3 774,6 Кб	18 040,0 Кб	[список файлов]
s390x	1.8.13-4+b1	3 648,9 Кб	16 854,0 Кб	[список файлов]

Эта страница также доступна на следующих языках (Как установить язык по умолчанию):

При загрузке с официального сайта я сначала загрузил установочный пакет doxygen-1.8.13.src.tar.gz и обнаружил, что только этот установочный пакет недоступен, а исполняемый файл конфигурации и файл makefile отсутствуют. для загрузки другой установки Пакет doxygen-1.8.13.linux.bin.tar.gz. Китайская версия операционной системы Linux по умолчанию будет храниться в папке «Download» после загрузки, а английская версия операционной системы Linux по умолчанию будет сохранена в папке «Downloads» после загрузки.

После завершения загрузки откройте терминал и введите команду:

(2)tar xvfz doxygen-1.8.13.src.tar.gz

(3)tar xvfz doxygen-1.8.13.linux.bin.tar.gz

(4) cd doxygen-1.8.13

(7)sudo make install

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

Не удалось получить статус файла «bin / doxytag», мы можем сначала взглянуть на папку Makefile и bin и обнаружить, что файлы, которые необходимо использовать в Makefile, не находятся в папке bin.

Если вы хотите правильно установить doxygen, вы должны изменить Makefile. Откройте файл Makefile с помощью команды vim Makefile и измените файл Makefile в соответствии с файлами в папке bin, как показано ниже:

Затем используйте команду sudo make install, чтобы установить его.

2. Настройте рабочую среду Doxygen.

Войдите в каталог проекта (например, test) cd test /

Создать файл конфигурации Doxygen -g

Имя файла конфигурации по умолчанию - «Doxyfile», или вы можете использовать формат команды «doxygen -g your-cfg-filename», чтобы указать имя сгенерированного файла конфигурации. Если в этом нет особой необходимости, просто используйте имя файла конфигурации по умолчанию.

Содержимое файла Doxyfile очень велико, около 1000 строк, но около 4/5 из них являются комментариями, и каждый параметр конфигурации имеет подробный комментарий. В будущем, если у вас есть определенное понимание значения различных параметров конфигурации Doxygen, вы можете добавить параметр «-s» к команде для создания файла конфигурации для создания файла конфигурации без комментариев, как показано ниже:

3. Соответствующие настройки конфигурационного файла

Затем вам нужно открыть документ Doxygen и настроить некоторые поля.В общем, вам нужно настроить всего дюжину из них:

PROJECT_NAME = “Test“

PROJECT_NUMBER = "1.0.0”

OUTPUT_DIRECTORY = doc/

OUTPUT_LANGUAGE = Chinese

OPTIMIZE_OUTPUT_FOR_C = YES

TYPEDEF_HIDES_STRUCT = YES

HIDE_SCOPE_NAMES = YES

QUIET = YES

EXAMPLE_PATTERNS = *.c *.h

EXAMPLE_RECURSIVE = YES

SOURCE BROWSER = YES

$ Это добавит боковую панель в HTML-документ и отобразит отношения между пакетами, классами, интерфейсами и т. Д. В древовидной структуре.

GENERATE TREEVIEW ＝ ALL

4. Документация по исходному коду программы.

После того, как рабочая среда Doxygen подготовлена, если вы хотите использовать Doxygen, вы должны использовать правила комментариев, требуемые Doxygen, в комментариях исходного кода, иначе Doxygen не распознает его.

Типы аннотаций Doxygen можно разделить на:

(1) Тип строки: оператор комментария не появляется в той же строке, что и исходный код программы. Он в основном используется для комментирования типов данных, таких как struct, enum и union (uion), которые также появляются в файле заголовка. в качестве интерфейса программы. Функции и правила использования следующие:

* Это пример знака межстрочного комментария, распознаваемого Doxygen

(2) Встроенные комментарии: операторы комментариев появляются в той же строке, что и исходный код программы, и в основном используются для частичных комментариев кода. На следующем рисунке показана метка встроенного комментария, распознаваемая Doxygen.

Pthread_t tid; /// ID потока

Job next; /// Следующий узел списка ссылок

Int val; /// Значение узла

5. Генерация программной документации.

Если это файл конфигурации Doxyfile, созданный командой «doxygen -g», то введите doxygen напрямую в терминал для создания документации по программе, и документация будет сохранена в только что установленной папке doc.

Doxygen - популярный генератор документации на основе исходных текстов. Что такое Doxygen, очень хорошо написано в Википедии, поэтому в статье я расскажу только о том, как быстро установить и начать использовать Doxygen.

Итак, процесс по шагам:

1. Качаем по ссылке [1], доступны версии для Linux i386, Mac OS X 10.6 (Snow Leopard), Mac OS X 10.4 (Tiger), Windows XP/Vista/7, а также исходники (Doxygen распространяется под лицензией GPL).

2. Запускаем doxygen-1.7.2-setup.exe. Отвечаем на несложные традиционные вопросы инсталлятора (можно тупо жать Next). После инсталляции появится папка c:\Program Files\doxygen\, где и находится вся система Doxygen, документация по ней, и утилиты.

3. Запускаем c:\Program Files\doxygen\bin\doxywizard.exe. Это программа, которая позволяет упростить создание и использование конфигурационного файла для создания документации (Doxygen GUI frontend).

5. Теперь осталось перейти на закладку Run и нажать на кнопку Run doxygen:

Запуск генерации документации можно также провести из командной строки вводом команды (config-file имя файла конфигурации doxygen):

В моем примере в папке VirtualSerial\Documentation\html\ появятся файлы в формате html. Начинать просмотр документации нужно с файла VirtualSerial\Documentation\html\index.html.

Если конфигурационного файла нет, то можно вручную сгенерить конфигурацию. Нужно выполнить, как минимум, следующие шаги (для примера VirtualSerial):

Закладка Wizard -> Project:
- в поле "Step 1: Specify the working directory from which doxygen will run" указать путь до каталога проекта. В моем случае это c:\aaa2\LUFA 100807\Demos\Device\ClassDriver\VirtualSerial\
- в поле "Project name:" укажите имя проекта (LUFA Library - Virtual Serial Device Demo).
- в поле "Project version or id:" укажите версию проекта (0.0.0).
- в поле "Source code directory:" укажите ./
- в поле "Destination directory:" укажите ./Documentation/
- если Ваш проект содержит подпапки с исходниками, поставьте галочку "Scan recursiVely".

Закладка Wizard -> Mode:
- Select the desired extraction mode: -> All Entities.
- Select programming language to optimize the results for -> Optimize for C or PHP output

Закладка Wizard -> Output (выберем на этот раз формат RTF):
- убираем галочку HTML
- убираем галочку LaTeX
- ставим галочку Rich Text Format (RTF)

Закладка Wizard -> Diagrams:
- Diagrams to generate -> No diagrams

Закладка Run:
- нажимаем кнопку Run Doxugen. В результате получим файл единственный файл VirtualSerial\Documentation\rtf\refman.rtf.

Полученный файл конфигурации можно сохранить для дальнейшего использования (File -> Save as. -> Doxyfile).

[Проблема правильной обработки кодировки русского языка]

По умолчанию Doxygen генерирует html-текст в кодировке UTF-8 (используется мета-тег), и предполагает, что входной формат текста тоже UTF-8. С такими настройками поставляются большинство конфигов Doxygen. При попытке сгенерировать с таким конфигом html-документацию из текстового формата windows-1251 (с таком формате имеется большинство файлов исходников, содержащих русскоязычные комментарии), на выходе получается html-файл, который отображается всеми браузерами с кракозябрами. Эти кракозябры исчезнут, если вручную переключить браузер из кодировки UTF-8 в кодировку windows-1251. Это, конечно, не решение проблемы - возникает неудобство, так как необходимо постоянно переключаться в кодировку windows-1251. Заставить doxygen генерировать тег с charset=windows-1251 невозможно. Однако проблема фиксится довольно просто - достаточно в конфигурационном файле doxygen указать правильную кодировку входного файла - вместо кодировки UTF-8 указать кодировку windows-1251. Делается это правкой переменной конфига INPUT_ENCODING:

Кроме того, если нужно правильно распознать русский текст, который есть в файле Doxygen.conf (например, это может быть текст имени проекта PROJECT_NAME и другие строки), то необходимо отредактировать переменную конфига DOXYFILE_ENCODING (указать кодировку windows-1251):

После такого исправления html будет корректно генерироваться, и правильно отображаться всеми браузерами, русский текст будет без кракозябр.

[Экранирование специальных символов doxygen]

Пакет Doxygen-1.7.5

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

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

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

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

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

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

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

Замечание

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

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

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

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

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

--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 --help для объяснения параметров командной строки

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

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

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

Читайте также: