Общие переменные конфигурации

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

alias

Переменная alias переименовывает команду QDoc.

Общий синтаксис: alias.original-command-name = temporary-command-name.

alias.e = i

Это переименовывает встроенную команду \e (курсив) в \i. Переменная alias часто используется по соображениям совместимости.

См. также макрос.

codeindent

Переменная codeindent определяет уровень отступа, который QDoc использует при записи фрагментов кода.

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

codeprefix, codesuffix

Переменные codeprefix и codesuffix задают пару строк, в которые заключается каждый фрагмент кода.

defines

Переменная defines задаёт символы препроцессора C++, которые QDoc будет распознавать и обрабатывать.

Когда символ препроцессора задается с помощью переменной defines, вы также можете использовать команду \if для включения документации, которая будет отображаться только если символ препроцессора определён.

Значения переменной — это регулярные выражения (см. QRegExp для подробностей). По умолчанию, ни один символ не определён, что означает, что код, защищённый с помощью #ifdef...#endif, будет пропущен.

defines = Q_QDOC \
          QT_.*_SUPPORT \
          QT_.*_LIB \
          QT_COMPAT \
          QT3_SUPPORT \
          Q_OS_.* \
          Q_BYTE_ORDER \
          __cplusplus

Это гарантирует, что QDoc обработает код, требующий определения этих символов. Например:

#ifdef Q_OS_WIN
  HDC getDC() const;
  void releaseDC(HDC) const;
#endif

Так как регулярное выражение Q_OS_.* (заданное с помощью переменной defines) соответствует Q_OS_WIN, QDoc обработает код внутри #ifdef и #endif в нашем примере.

Вы также можете вручную определить символы препроцессора в командной строке, используя опцию -D. Например:

currentdirectory$ qdoc -Dqtforpython qtgui.qdocconf

В этом случае опция -D гарантирует, что символ препроцессора qtforpython будет определён, когда QDoc обрабатывает исходные файлы, определённые в файле qtgui.qdocconf.

См. также falsehoods и \if.

depends

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

Как и сам Qt, документация Qt распределена по нескольким модулям. В проекте документации с несколькими модулями минимальный набор зависимостей для одного модуля состоит из фактических зависимостей сборки. Кроме того, если есть проект документации (модуль), который является точкой входа верхнего уровня для всего набора документации и предоставляет ссылки navigation-variable[navigation}, каждая модульная документация должна включать его в качестве зависимости.

Когда QDoc генерирует документацию для проекта, он также создает файл .index, содержащий URL-адреса каждой связуемой сущности в проекте. Каждая зависимость — это (строчная) имя проекта. Это имя должно совпадать с базовым именем файла индекса, сгенерированного для этого проекта.

depends = \
    qtdoc \
    qtcore \
    qtquick

При вызове QDoc для проекта, имеющего зависимости и использующего переменную depends, один или несколько путей -indexdir должны быть переданы как опции командной строки. QDoc использует эти пути для поиска файлов индекса зависимостей.

qdoc mydoc.qdocconf -outputdir $PWD/html -indexdir $QT_INSTALL_DOCS

В данном случае QDoc будет искать файл $T_INSTALL_DOCS/qtdoc/qtdoc.index для зависимости к qtdoc. Если файл индекса для зависимости не найден, QDoc выведет предупреждение.

Команда depends также принимает специальное значение «*». Это инструктирует QDoc загрузить все файлы индекса, найденные в указанных каталогах индексов; то есть «зависит от всего».

depends = *

См. также индексы, проект и url.

exampledirs

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

Переменные examples и exampledirs используются командами \quotefromfile, \quotefile и \example. Если определены обе переменные examples и exampledirs, QDoc будет искать в обоих, сначала в examples, затем в exampledirs.

QDoc будет искать в каталогах в указанном порядке и принять первый найденный соответствующий файл. Он будет искать только в указанных каталогах, а не в подкаталогах.

exampledirs = $QTDIR/doc/src \
              $QTDIR/examples \
              $QTDIR \
              $QTDIR/qmake/examples

examples    = $QTDIR/examples/widgets/analogclock/analogclock.cpp

При обработке

\quotefromfile widgets/calculator/calculator.cpp

QDoc проверит, есть ли файл с именем calculator.cpp в качестве значения в переменной examples. Если его нет, он будет искать в переменной exampledirs, и сначала проверит, существует ли файл с именем

$QTDIR/doc/src/widgets/calculator/calculator.cpp

Если нет, QDoc продолжит поиск файла с именем

$QTDIR/examples/widgets/calculator/calculator.cpp

и так далее.

См. также examples.

examples

Переменная examples позволяет указать отдельные файлы примеров помимо тех, которые находятся в каталогах, указанных переменной exampledirs.

Переменные examples и exampledirs используются командами \quotefromfile, \quotefile и \example. Если определены обе переменные examples и exampledirs, QDoc будет искать в обоих, сначала в examples, затем в exampledirs.

QDoc будет искать среди значений, перечисленных для переменной examples, в указанном порядке и примет первое найденное.

Для подробного примера, см. команду exampledirs. Но обратите внимание, что если вы знаете, что файл указан в переменной examples, вам не нужно указывать его путь:

\quotefromfile calculator.cpp

См. также exampledirs.

examples.fileextensions

Переменная examples.fileextensions задаёт расширения файлов, которые QDoc будет искать при сборе файлов примеров для отображения в документации.

По умолчанию расширения: *.cpp, *.h, *.js, *.xq, *.svg, *.xml и *.ui.

Расширения задаются как стандартные шаблоны подстановок. Вы можете добавить расширение файла к фильтру, используя «+=». Например:

examples.fileextensions += *.qrc

См. также headers.fileextensions.

excludedirs

Переменная excludedirs используется для перечисления каталогов, которые не должны обрабатываться QDoc, даже если те же каталоги включены переменными sourcedirs или headerdirs.

Например:

sourcedirs =  src/corelib
excludedirs = src/corelib/tmp

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

См. также excludefiles.

excludefiles

Переменная excludefiles позволяет указать отдельные файлы, которые не должны обрабатываться QDoc.

excludefiles += $QT_CORE_SOURCES/../../src/widgets/kernel/qwidget.h \
                $QT_CORE_SOURCES/../../src/widgets/kernel/qwidget.cpp

Если вы включите это в свой файл qdocconf для qtbase, документация класса QWidget не будет сгенерирована.

С Qt 5.6 переменная excludefiles также распознает простые подстановки (* и ?). Например, чтобы исключить все частные заголовочные файлы Qt из парсинга, определите следующее:

excludefiles += "*_p.h"

См. также excludedirs.

extraimages

Переменная extraimages указывает QDoc включить определенные изображения в сгенерированную документацию.

QDoc не распознает изображения, используемые в HTML (или любом другом языке разметки). Если мы хотим скопировать изображения из каталогов, указанных в imagedirs (используемые изображения должны быть в этих каталогах) в каталог вывода, мы должны указать изображения с помощью переменной extraimages.

Общий синтаксис: extraimages.format = image. Расширение файла необязательно.

Например, в qtgui.qdocconf мы используем несколько изображений в переменной HTML.postheader, значением которой является чистый HTML. Поэтому эти изображения указаны с помощью переменной extraimages:

extraimages.HTML = qt-logo

См. также images и imagedirs.

falsehoods

Переменная falsehoods определяет логическое значение заданных символов препроцессора как false.

Значения переменной — это регулярные выражения (см. QRegExp для подробностей). Если эта переменная не установлена для символа препроцессора, QDoc предполагает, что его истинное значение — true. Исключением является «0», которое всегда ложно.

QDoc распознает и может оценить следующий синтаксис препроцессора:

#ifdef NOTYET
 ...
#endif

#if defined (NOTYET)
 ...
#end if

Однако, столкнувшись с неизвестным синтаксисом, таким как

#if NOTYET
    ...
#endif

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

falsehoods = NOTYET

См. также defines.

generateindex

Переменная generateindex содержит булево значение, определяющее, генерировать ли файл индекса при создании HTML-документации.

По умолчанию файл индекса всегда генерируется с HTML-документацией, поэтому эта переменная обычно используется только при отключении этой функции (установив значение в false) или при включении генерации индекса для вывода WebXML (установив значение в true).

headerdirs

Переменная headerdirs указывает на каталоги, содержащие заголовочные файлы, связанные с .cpp исходными файлами, используемыми в документации.

headerdirs = $QTDIR/src \
             $QTDIR/extensions/activeqt \
             $QTDIR/extensions/motif \
             $QTDIR/tools/designer/src/lib/extension \
             $QTDIR/tools/designer/src/lib/sdk \
             $QTDIR/tools/designer/src/lib/uilib

При выполнении QDoc в первую очередь прочитает заголовки, указанные в переменной headers, а также расположенные в каталогах, указанных в переменной headerdir (включая все подкаталоги), создавая внутреннюю структуру классов и их функций.

Затем он прочитает исходные файлы, указанные в sources, а также расположенные в каталогах, указанных в sourcedirs переменной (включая все подкаталоги), объединяя документацию со структурой, полученной из заголовочных файлов.

Если переменные headers и headerdirs определены, QDoc прочитает оба, сначала headers, затем headerdirs.

В указанных каталогах QDoc будет считывать только файлы с расширениями, указанными в headers.fileextensions переменной. По умолчанию это *.ch, *.h, *.h++, *.hh, *.hpp и *.hxx. Файлы, указанные в headers будут считываться без учёта их расширений.

См. также headers и headers.fileextensions.

headers

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

headers = $QTDIR/src/gui/widgets/qlineedit.h \
          $QTDIR/src/gui/widgets/qpushbutton.h

При обработке переменной headers QDoc ведет себя так же, как и при обработке переменной headerdirs. Дополнительная информация в headerdirs переменной.

См. также headerdirs.

headers.fileextensions

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

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

По умолчанию это *.ch, *.h, *.h++, *.hh, *.hpp и *.hxx.

Расширения задаются в виде стандартных шаблонов. Вы можете добавить расширение к фильтру с помощью '+='. Например:

header.fileextensions += *.H

Предупреждение: Возможно, приведённая выше присваивание не будет работать должным образом.

См. также headerdirs.

ignorewords

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

QDoc имеет функцию автоматической привязки, где попытка привязки выполняется для слов, похожих на сущности C++, QML или JavaScript. Строка подходит для автоматической привязки, если она состоит из не менее трёх символов, не содержит пробелов и

• является словом в формате camelCase, то есть содержит хотя бы одну заглавную букву с индексом больше нуля, или
• содержит подстроку () или ::, или
• содержит хотя бы один специальный символ, @ или _.

Добавление квалифицированного слова в ignorewords предотвращает автоматическую привязку QDoc к этому слову. Например, если слово OpenGL является допустимой целью ссылки (раздел, \page, или \externalpage заголовок), гиперссылку для каждого вхождения можно избежать с помощью

ignorewords += OpenGL

Явное связывание с помощью \l по-прежнему работает для проигнорированных слов.

Переменная ignorewords была добавлена в QDoc 5.14.

ignoresince

Переменная ignoresince используется для установки значения отсечения для версий, переданных команде \since. Все команды \since, определяющие версию ниже значения отсечения, игнорируются и не генерируют вывод.

Значения отсечения зависят от проекта. Имя проекта можно определить как подпеременную. По умолчанию имя проекта Qt. Например:

ignoresince      = 5.0
ignoresince.QDoc = 5.0

Эти команды проигнорируют команды \since, где основная версия равна 4 или меньше, а проект — QDoc или не определен.

\since 3.2          # Ignored
\since 5.2          # Documented (as 'Qt 5.2')
\since QDoc 4.6     # Ignored
\since QtQuick 2.5  # Documented

Переменная ignoresince была добавлена в QDoc 5.15.

См. также \since.

imagedirs

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

Переменные images и imagedirs используются командами \image и \inlineimage. Если определены обе переменные images и imagedirs, QDoc будет искать в обоих. Сначала в images, затем в imagedirs.

QDoc будет искать в каталогах в указанном порядке и принять первый найденный совпадающий файл. Он будет искать только в указанных каталогах, не в подкаталогах.

imagedirs = $QTDIR/doc/src/images \
            $QTDIR/examples

images    = $QTDIR/doc/src/images/calculator-example.png

При обработке

\image calculator-example.png

QDoc проверит, есть ли файл с именем calculator-example.png в качестве значения в переменной images. Если нет, то он будет искать в переменной imagedirs:

$QTDIR/doc/src/images/calculator-example.png

Если файл не существует, QDoc будет искать файл с именем

$QTDIR/examples/calculator-example.png

Вы можете фильтровать изображения в каталоге изображений с помощью переменной images.fileextensions. Основная идея переменной images.fileextensions заключается в возможности использовать разные форматы изображений для разных форматов вывода.

Предупреждение: Функциональность переменной images.fileextensions находится на начальной стадии, так как QDoc на данный момент поддерживает только HTML.

См. также images и images.fileextensions.

images

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

images = $QTDIR/doc/src/images/calculator-example.png

При обработке переменной images QDoc ведет себя так же, как и при обработке imagedirs переменной. Дополнительная информация в imagedirs переменной.

См. также imagedirs и images.fileextensions.

images.fileextensions

Переменная images.fileextensions фильтрует файлы в каталоге изображений.

Значения переменной (расширения) задаются в виде стандартных шаблонов. Общий синтаксис: images.fileextensions.format = *.extension.

Идея заключается в возможности использовать разные форматы изображений для разных форматов вывода.

images.fileextensions.HTML = *.png
images.fileextensions.LOUT = *.eps

Затем при обработке команд \image и \inlineimage, QDoc будет искать только файлы с расширениями, указанными в переменной, содержащей список форматов вывода.

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

По умолчанию для HTML это *.png, *.jpg, *.jpeg и *.gif.

Вы можете добавить расширение к фильтру с помощью '+='. Например:

images.fileextensions.HTML += *.eps

См. также imagedirs и images.

language

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

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

language = Cpp

Это идентифицирует C++ как язык исходного кода Qt.

locationinfo

Булево значение переменной locationinfo определяет, будет ли записана подробная информация о местоположении каждой сущности в файлы .index и .webxml (при использовании формата вывода WebXML).

Информация о местоположении включает полный путь и номер строки либо объявления, либо блока комментариев к документации в исходном коде.

Установка значения в false отключает информацию о местоположении:

locationinfo = false

Значение по умолчанию равно true.

Переменная locationinfo была введена в QDoc 5.15.

Макросы

Переменная macro используется для создания собственных простых команд QDoc. Синтаксис macro.command = definition, где определение записывается с помощью синтаксиса QDoc.

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

macro.gui              = "\\b"
macro.raisedaster.HTML = "<sup>*</sup>"

Первый макрос определяет команду \gui для отображения её аргумента жирным шрифтом. Второй макрос определяет команду \raisedaster для отображения верхнего индекса звёздочки, но только при генерации HTML.

Макрос может также принимать до семи параметров:

macro.hello            = "Hello \1!"

Параметры передаются макросам так же, как и другим командам:

\hello World

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

macro.verinfo          = "\1 (version \2)"

\verinfo {QFooBar} {1.0 beta}

Для расширенных макросов можно добавить специальный параметр match для дополнительного соответствия шаблону с помощью регулярных выражений.

Например,

macro.qtminorversion       = "$QT_VER"
macro.qtminorversion.match = "\\d+\\.(\\d+)"

Это создаёт макрос \qtminorversion, который расширяется до значений малой версии, основываясь на переменной среды QT_VER.

Макрос, определяющий шаблон соответствия, выводит все группы захвата (скобки) вместе или точное совпавшее значение, если шаблон не содержит групп захвата.

См. также псевдоним.

manifestmeta

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

См. раздел Метаданные манифеста для получения дополнительной информации.

естественный язык

Переменная naturallanguage указывает естественный язык, используемый для документации, сгенерированной QDoc.

naturallanguage = zh-Hans

По умолчанию естественный язык en для совместимости со старой документацией.

QDoc добавит информацию о естественном языке в сгенерированный HTML, используя атрибуты lang и xml:lang.

См. также sourceencoding, outputencoding, C.7. Атрибуты lang и xml:lang и Рекомендация 13: Использование кодов Hans и Hant.

Навигация

Под-переменные navigation, если определены, задают домашнюю страницу, целевую страницу, страницу C++ классов и страницу типов QML, которые отображаются в навигационной панели для каждой страницы.

В проектах с несколькими подпроектами (например, модули Qt), каждый подпроект обычно определяет свою целевую страницу, а домашняя страница используется во всех подпроектах.

Под-переменные

Например:

# Common configuration
navigation.homepage  = index.html
navigation.hometitle = "Qt $QT_VER"

# qtquick.qdocconf
navigation.landingpage    = "Qt Quick"
navigation.cppclassespage = "Qt Quick C++ Classes"
navigation.qmltypespage   = "Qt Quick QML Types"

Вышеуказанная конфигурация создаёт следующую навигационную панель для QML типа Item.

Qt 5.10 > Qt Quick > QML Types > Item QML Type

outputdir

Переменная outputdir указывает каталог, в который QDoc поместит сгенерированную документацию.

outputdir = $QTDIR/doc/html

располагает сгенерированную документацию Qt Reference в $QTDIR/doc/html. Например, документация класса QWidget расположена в

$QTDIR/doc/html/qwidget.html

Сопутствующие изображения будут помещены в подкаталог images.

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

outputencoding

Переменная outputencoding задаёт кодировку, используемую для сгенерированной QDoc документации.

outputencoding = UTF-8

По умолчанию выходная кодировка ISO-8859-1 (Latin1) для совместимости со старой документацией. При генерации документации для некоторых языков, особенно неевропейских языков, этого недостаточно, и необходима кодировка, такая как UTF-8.

QDoc закодирует HTML с использованием этой кодировки и сгенерирует правильные объявления, чтобы указать браузерам используемую кодировку. Переменная конфигурации naturallanguage также должна быть указана, чтобы предоставить браузерам полный набор информации о кодировке символов и языке.

См. также outputencoding и naturallanguage.

outputformats

Переменная outputformats указывает формат(ы) сгенерированной документации.

Начиная с Qt 5.11, QDoc поддерживает форматы HTML и WebXML; начиная с Qt 5.15, он также может генерировать документацию в формате DocBook. Если outputformats не указаны, QDoc генерирует документацию в формате HTML (по умолчанию). Все форматы выходных данных могут быть указаны с выделенными каталогами выходных данных и другими настройками. Например:

outputformats = WebXML HTML
WebXML.nosubdirs = true
WebXML.outputsubdir = webxml
WebXML.quotinginformation = true

Это генерирует HTML-документацию с использованием значений по умолчанию, а также WebXML-документацию в подкаталог webxml.

outputprefixes

Переменная outputprefixes задаёт отображение между типами файлов и префиксов, которые будут добавлены к именам HTML-файлов в сгенерированной документации.

outputprefixes     = QML JS
outputprefixes.QML = uicomponents-
outputprefixes.JS  = uicomponents-

По умолчанию файлы, содержащие API-документацию для типов QML, имеют префикс "qml-", а для типов JavaScript - "js-". В приведенном выше примере используется префикс "uicomponents" вместо обоих.

Префикс выходных данных применяется к именам файлов для документации по типам QML и JS.

outputsuffixes

Переменная outputsuffixes указывает отображение между типами файлов и суффиксами имён модулей, добавляемыми к именам HTML-файлов.

outputsuffixes     = QML
outputsuffixes.QML = -tp

Учитывая имя модуля QML FooBar и префикс по умолчанию output prefix ("qml-"), имя файла сгенерированной HTML-страницы для QML-типа FooWidget будет qml-foobar-tp-foowidget.html.

По умолчанию суффикс не используется. Если суффикс выходных данных определён, он применяется к именам файлов для документации по типам QML и JS, а также к страницам модулей.

Переменная outputsuffixes была введена в QDoc 5.6.

qhp

Переменная qhp используется для определения информации, которая будет записана в файлы проекта Qt Help (qhp).

См. главу Создание файлов проекта справки для получения информации об этом процессе.

sourcedirs

Переменная sourcedirs указывает каталоги, содержащие файлы .cpp или .qdoc , используемые в документации.

sourcedirs  += .. \
               ../../../examples/gui/doc/src

При выполнении QDoc в первую очередь прочитает заголовки, указанные в переменной header, и расположенные в каталогах, указанных в переменной headerdir (включая все подкаталоги), создавая внутреннюю структуру классов и их функций.

Затем он прочитает исходные файлы, указанные в sources, и расположенные в каталогах, указанных в переменной sourcedirs (включая все подкаталоги), объединяя документацию со структурой, полученной из файлов заголовков.

Если и переменная sources и sourcedirs определены, QDoc прочитает оба, сначала sources, затем sourcedirs.

В указанных каталогах QDoc будет читать только файлы с расширениями, указанными в sources.fileextensions переменной. Расширения по умолчанию — *.c++, *.cc, *.cpp и *.cxx. Файлы, указанные в sources, будут читаться независимо от расширения файла.

См. также sources и sources.fileextensions.

sourceencoding

Переменная sourceencoding указывает кодировку, используемую для исходного кода и документации.

sourceencoding = UTF-8

По умолчанию кодировка исходного файла ISO-8859-1 (Latin1) для совместимости со старой документацией. Для некоторых языков, особенно неевропейских, этого недостаточно, и необходима кодировка, например, UTF-8.

Хотя QDoc будет использовать кодировку для чтения файлов исходного кода и документации, ограничения компиляторов C++ могут помешать вам использовать не-ASCII символы в комментариях исходного кода. В таких случаях можно написать API-документацию полностью в файлах документации.

См. также naturallanguage и outputencoding.

sources

Переменная sources позволяет указать отдельные исходные файлы помимо тех, которые находятся в каталогах, указанных в переменной sourcedirs.

sources = $QTDIR/src/gui/widgets/qlineedit.cpp \
          $QTDIR/src/gui/widgets/qpushbutton.cpp

При обработке переменной sources QDoc ведет себя так же, как и при обработке переменной sourcedirs. Дополнительную информацию см. в переменной sourcedirs.

См. также sourcedirs.

sources.fileextensions

Переменная sources.fileextensions фильтрует файлы внутри каталога исходных файлов.

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

По умолчанию расширения — *.c++, *.cc, *.cpp и *.cxx.

Расширения задаются как стандартные шаблоны. Можно добавить расширение к фильтру, используя '+='. Например:

sources.fileextensions += *.CC

Предупреждение: Приведенное выше назначение может работать не так, как описано.

См. также sourcedirs и sources-variable} {sources}.

spurious

Переменная spurious исключает указанные предупреждения QDoc из вывода. Предупреждения задаются с использованием стандартных шаблонов.

spurious = "Cannot find .*" \
"Missing .*"

обеспечивает, что предупреждения, соответствующие одному из этих шаблонов, не будут частью вывода при выполнении QDoc. Например, следующее предупреждение будет опущено из вывода:

src/opengl/qgl_mac.cpp:156: Missing parameter name

syntaxhighlighting

Переменная syntaxhighlighting определяет, должен ли QDoc выполнять подсветку синтаксиса для кода в документации, которую он генерирует.

syntaxhighlighting = true

включит подсветку синтаксиса для всех поддерживаемых языков программирования.

tabsize

Переменная tabsize определяет размер символа табуляции.

tabsize = 4

присвоит символу табуляции размер в 4 пробела. Значение по умолчанию для этой переменной равно 8, и ее не обязательно указывать.

tagfile

Переменная tagfile указывает файл тегов Doxygen, который должен быть записан при генерации HTML.

version

Переменная version указывает номер версии документированного программного обеспечения.

version = 5.6.0

Когда номер версии указан (с использованием переменных version или versionsym в файле .qdocconf), он доступен через соответствующую команду \version для использования в документации.

Предупреждение: Функциональность команды \version не полностью реализована; в настоящее время она работает только внутри кода в формате HTML.

См. также versionsym.

versionsym

Переменная versionsym указывает символ препроцессора C++, который определяет номер версии документированного программного обеспечения.

versionsym = QT_VERSION_STR

QT_VERSION_STR определён в qglobal.h следующим образом

#define QT_VERSION_STR   "5.14.1"

Когда номер версии указан (с использованием переменных version или versionsym в файле .qdocconf), он доступен через соответствующую команду \version для использования в документации.

Предупреждение: Функциональность команды \version не полностью реализована. В настоящее время она работает только внутри кода в формате HTML.

См. также \version.

warninglimit

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

Установление значения warninglimit в 0 означает ошибку при любом предупреждении.

Примечание: По умолчанию QDoc не принудительно соблюдает ограничение по предупреждениям. Включите его с помощью warninglimit.enabled = true или определив переменную среды QDOC_ENABLE_WARNINGLIMIT.

Например,

# Fail the documentation build if we have more than 100 warnings
warninglimit = 100
warninglimit.enabled = true

Переменная warninglimit была добавлена в Qt 5.11.