Файл конфигурации 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
• depends
• exampledirs
• examples
• examples.fileextensions
• excludedirs
• excludefiles
• extraimages
• falsehoods
• headerdirs
• headers
• headers.fileextensions
• HTML.footer
• HTML.postheader
• HTML.style
• ignorewords
• ignoresince
• imagedirs
• images
• images.fileextensions
• indexes
• language
• locationinfo
• macro
• manifestmeta
• navigation
• outputdir
• outputformats
• outputprefixes
• outputsuffixes
• project
• sourcedirs
• sources
• sources.fileextensions
• spurious
• tabsize
• url
• url.examples
• version
• versionsym
• warninglimit

Категории

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

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

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