Spec-Zone.ru › Qt 5.13

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

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

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

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

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

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

language = Cpp

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

macro

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

См. раздел Manifest Meta Content для получения дополнительной информации.

naturallanguage

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

naturallanguage = zh-Hans

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

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

См. также sourceencoding, outputencoding, C.7. The lang and xml:lang Attributes и Best Practice 13: Using Hans and Hant codes.

navigation

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

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

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

navigation.homepage Домашняя страница проекта.
navigation.hometitle (Необязательно) Отображаемое название домашней страницы. Значение по умолчанию взято из homepage.
navigation.landingpage Стартовая страница подпроекта.
navigation.landingtitle (Необязательно) Отображаемое название стартовой страницы. Значение по умолчанию взято из landingpage.
navigation.cppclassespage Главная страница, перечисляющая все классы C++ для этого (под-)проекта. Обычно название страницы \module.
navigation.cppclassestitle (Необязательно) Отображаемое название страницы классов C++. По умолчанию — "Классы C++".
navigation.qmltypespage Главная страница, перечисляющая все типы QML для этого (под-)проекта. Обычно название страницы \qmlmodule.
navigation.qmltypestitle (Необязательно) Отображаемое название страницы типов QML. По умолчанию — "Типы QML".

Например:

# 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 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. Если переменная 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   "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.

© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.13/22-qdoc-configuration-generalvariables.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API