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

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

См. также falsehoods и \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.

ignorewords

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

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

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

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

ignorewords += OpenGL

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

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

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.

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

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

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

outputdir = $QTDIR/doc/html

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

$QTDIR/doc/html/qwidget.html

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

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

кодировка_вывода

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

outputencoding = UTF-8

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

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

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

форматы_вывода

Переменная 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 задаёт отображение типов файлов и префиксов, добавляемых к именам файлов HTML в сгенерированной документации.

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

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

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

суффиксы_вывода

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

outputsuffixes     = QML
outputsuffixes.QML = -tp

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

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

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

qhp

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

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

каталоги_источников

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

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

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

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

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

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

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

кодировка_источников

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

sourceencoding = UTF-8

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

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

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

источники

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

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

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

См. также sourcedirs.

расширения_источников

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

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

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

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

sources.fileextensions += *.CC

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

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

лишние

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

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

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

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

подсветка_синтаксиса

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

syntaxhighlighting = true

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

размер_табуляции

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

tabsize = 4

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

файл_тегов

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

версия

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