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

С помощью общих переменных конфигурации 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 -Dconsoleedition qtgui.qdocconf

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

См. также ложь и \if.

edition

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

Эта функция в основном используется при предоставлении документации для пакетов Qt.

Переменная edition всегда используется с определенным именем версии для определения модулей для этой версии:

edition.Console      = QtCore QtNetwork QtSql QtXml
edition.Desktop      = QtCore QtGui QtNetwork QtOpenGL QtSql QtXml \
                       QtDesigner QtAssistant Qt3Support QAxContainer \
                       QAxServer
edition.DesktopLight = QtCore QtGui Qt3SupportLight

В приведенных выше примерах версия Console включает содержимое только четырех модулей. Только классы из этих модулей будут использоваться при использовании команды generatelist для генерации списка классов для этой версии:

\generatelist{classesbyedition Console}

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 определяет истинностное значение указанных символов препроцессора как ложное.

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

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

#ifdef NOTYET
 ...
#endif

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

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

#if NOTYET
    ...
#endif

QDoc по умолчанию оценит его как истинное, если только символ препроцессора не указан в записи переменной 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.fileextensions.

заголовки

Переменная 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.

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 указывает язык исходного кода, используемого в документации.

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

language = Cpp

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

макрос

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

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

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.

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

См. также alias.

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"

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

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

outputdir

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

outputdir = $QTDIR/doc/html

размещает сгенерированную документацию Qt по ссылке $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. Если нет 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 (включая все поддиректории), создавая внутреннюю структуру классов и их функций.

Затем QDoc прочитает источники, указанные в 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   "4.0.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.