Конфигурационный файл QDoc

Перед запуском QDoc необходимо создать конфигурационный файл QDoc, чтобы указать QDoc, где находятся исходные файлы с комментариями QDoc. Путь к вашему конфигурационному файлу передается в QDoc в командной строке:

/current/dir$ ../../bin/qdoc ./config.qdocconf

Общее описание

Конфигурационный файл представляет собой список записей вида "переменная = значение". Используя конфигурационные переменные, вы можете определить, где QDoc должен найти различные исходные файлы, изображения и примеры, куда поместить сгенерированную документацию и т. д. Конфигурационный файл также может содержать директивы, например, include. Пример см. в минимальном файле qdocconf.

Вы также можете использовать конфигурационные переменные, чтобы QDoc поддерживал производные проекты, то есть QDoc может генерировать ссылки в документации вашего проекта на элементы онлайн-документации Qt. См. раздел Поддержка производных проектов.

Значение конфигурационной переменной можно установить, используя либо «=», либо «+=». Разница заключается в том, что «=» перезаписывает предыдущее значение, а «+=» добавляет новое значение к текущему.

Некоторые конфигурационные переменные принимают в качестве значения список строк, например: sourcedirs, в то время как другие принимают только одну строку. Двойные кавычки вокруг строкового значения необязательны, но их включение позволяет использовать специальные символы, такие как «=» и « " » в строке значения, например:

HTML.postheader = "<a href=\"index.html\">Home</a>"

Если запись занимает несколько строк, используйте обратную косую черту в конце каждой строки, кроме последней:

sourcedirs = kernel \
             tools \
             widgets

Конфигурационные переменные

Список переменных

• alias
• Cpp.ignoredirectives
• Cpp.ignoretokens
• defines
• edition
• exampledirs
• examples
• examples.fileextensions
• excludedirs
• excludefiles
• extraimages
• falsehoods
• headerdirs
• headers
• headers.fileextensions
• HTML.footer
• HTML.postheader
• HTML.style
• imagedirs
• images
• images.fileextensions
• language
• macro
• manifestmeta
• navigation
• outputdir
• outputformats
• outputprefixes
• outputsuffixes
• sourcedirs
• sources
• sources.fileextensions
• spurious
• tabsize
• url
• url.examples
• version
• versionsym
• warninglimit

Категории

• Общие конфигурационные переменные
• Конфигурационные переменные, специфичные для C++
• Конфигурационные переменные, специфичные для формата

Примеры конфигурационных файлов

• Минимальный конфигурационный файл: minimum.qdocconf
• Конфигурационный файл Qt: qtgui.qdocconf