Qtgui.qdocconf с заметками

Этот документ описывает типичный файл Qt 5 qdocconf. Содержимое взято из файла qtgui.qdocconf Qt GUI.

Ниже вы найдете полное содержимое qtgui.qdocconf. В последующем разделе будет обсуждаться каждая директива в файле qdocconf.

include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)

project                 = QtGui
description             = Qt GUI Reference Documentation
url                     = http://doc.qt.io/qt-5
version                 = $QT_VERSION

examplesinstallpath     = gui

qhp.projects            = QtGui

qhp.QtGui.file         = qtgui.qhp
qhp.QtGui.namespace           = org.qt-project.qtgui.$QT_VERSION_TAG
qhp.QtGui.virtualFolder       = qtgui
qhp.QtGui.indexTitle          = Qt GUI
qhp.QtGui.indexRoot           =

qhp.QtGui.filterAttributes    = qtgui $QT_VERSION qtrefdoc
qhp.QtGui.customFilters.Qt.name = Qtgui $QT_VERSION
qhp.QtGui.customFilters.Qt.filterAttributes = qtgui $QT_VERSION

qhp.QtGui.subprojects         = classes
qhp.QtGui.subprojects.classes.title = C++ Classes
qhp.QtGui.subprojects.classes.indexTitle = Qt GUI C++ Classes
qhp.QtGui.subprojects.classes.selectors = class fake:headerfile
qhp.QtGui.subprojects.classes.sortPages = true

tagfile                 = ../../../doc/qtgui/qtgui.tags

depends += \
    qtcore \
    qtnetwork \
    qtopengl \
    qtsvg \
    qtqml \
    qtquick \
    qtwidgets \
    qtdoc

headerdirs  += ..

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

excludedirs  = ../../../examples/gui/doc/src/tmp

exampledirs += ../../../examples/gui \
               snippets

imagedirs   += images \
               ../../../examples/gui/doc/images \
               ../../../doc/src/images \

include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)

QDoc наследует значения по умолчанию для шаблонов, макросов и настроек из каталога, указанного переменной $QT_INSTALL_DOCS. qmake выводит значение этой переменной.

qmake -query

См. также: include.

project                 = QtGui

Переменная project задает имя сборки QDoc. Это имя также используется для формирования файла индекса, который в данном случае будет qtgui.index. Имя файла индекса не принимает заглавные буквы имени проекта.

См. также: project.

description             = Qt GUI Reference Documentation

Краткое описание проекта.

url                     = http://doc.qt.io/qt-5

Переменная url содержит базовый URL-адрес проекта.

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

Примечание: QDoc опускает это значение, когда при запуске QDoc указан аргумент -installdir.

examplesinstallpath     = gui

Эта переменная examplesinstallpath указывает, что примеры будут установлены в каталог gui внутри родительского каталога примеров (для Qt это $QT_INSTALL_EXAMPLES).

Примечание: Переменная examplepath должна соответствовать каталогу примеров, указанному в exampledirs.

Примечание: Можно переопределить exampleinstallpath для конкретного \example с помощью команды \meta.

См. также: exampledirs и \meta.

qhp.projects    = QtGui
qhp.QtGui.file  = qtgui.qhp

Следующие параметры предназначены для создания файла QHP (.qhp). Программа qhelpgenerator может преобразовать файл QHP в файл QCH (.qch), который можно открыть в Qt Assistant или Qt Creator.

qhp.QtGui.namespace           = org.qt-project.qtgui.$QT_VERSION_TAG

Уникальный идентификатор, который позволяет QHelpEngine извлечь файл справки по заданной ссылке. Этот namespace также используется в качестве базового URL для ссылок на файл справки.

qhp.QtGui.virtualFolder       = qtgui

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

Если два руководства находятся в одной виртуальной папке, можно ссылаться на разделы другого руководства, используя относительные пути. Тэг виртуальной папки обязателен, и папка не должна содержать символа '/'.

qhp.QtGui.indexTitle          = Qt GUI

Это заголовок страницы, содержащей содержимое.

qhp.QtGui.indexRoot           =

Указывает заголовок корневой (namespace) страницы для генерации документации. Обычно задаётся пустой строкой.

qhp.QtGui.filterAttributes    = qtgui $QT_VERSION qtrefdoc
qhp.QtGui.customFilters.Qt.name = QtGui $QT_VERSION
qhp.QtGui.customFilters.Qt.filterAttributes = qtgui $QT_VERSION

Набор документации (один на каждый проект QDoc) может иметь любое количество атрибутов фильтра. Атрибут фильтра — обычная строка, которую можно свободно выбрать. Дополнительно можно определить пользовательские фильтры, которые ссылаются на вышеуказанные атрибуты. Qt Assistant отобразит имя пользовательского фильтра в раскрывающемся списке Отфильтровано по. Будут отображаться только наборы документации, атрибуты фильтров которых совпадают с атрибутами выбранного пользовательского фильтра.

qhp.QtGui.subprojects         = classes
qhp.QtGui.subprojects.classes.title = C++ Classes
qhp.QtGui.subprojects.classes.indexTitle = Qt GUI C++ Classes

Подпроекты указывают разделы, которые отображаются в оглавлении для данного проекта. В этом примере подпроект, отображаемый в боковой панели Assistant, называется "C++ Classes", а его индекс — это страница с названием "QT GUI C++ Classes".

qhp.QtGui.subprojects.classes.selectors = class fake:headerfile

Список всех C++ классов и заголовочных файлов.

Дополнительную информацию можно найти в разделе Создание файлов проекта справки.

tagfile                 = ../../../doc/qtgui/qtgui.tags

Указывает файл тегов Doxygen, который необходимо создать при генерации HTML QDoc.

depends += \
   qtcore \
   qtnetwork \
   qtopengl \
   qtsvg \
   qtqml \
   qtquick \
   qtwidgets \
   qtdoc

Указывает модули, которые QDoc должен загрузить для генерации вывода для Qt GUI. QDoc загружает файлы индекса всех модулей, перечисленных в директиве depends, чтобы включить ссылки на страницы в этих модулях.

headerdirs  += ..

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

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

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

excludedirs  = ../../../examples/gui/doc/src/tmp

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

При выполнении QDoc будет игнорировать указанные каталоги. См. также: excludefiles.

exampledirs += ../../../examples/gui \
               snippets

См. также: examples, examplesinstallpath.

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

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

imagedirs   += images \
               ../../../examples/gui/doc/images \
               ../../../doc/src/images \

Добавляет указанные выше каталоги в список каталогов, где можно найти изображения.