Поддержка производных проектов

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

описание

Переменная description содержит краткое описание связанного проекта.

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

индексы

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

Например, чтобы сделать производный проект Qt содержащим ссылки на документацию справки Qt, необходимо указать соответствующий файл индекса:

indexes = $QTDIR/doc/html/qt.index

См. также проект и url.

проект

Переменная project предоставляет имя проекта, связанного с файлом .qdocconf.

Имя проекта используется для формирования имени файла связанного файла индекса проекта.

project = QtCreator

Это приведет к созданию файла индекса под названием qtcreator.index.

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

url

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

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

project     = Qt
description = Qt Reference Documentation
url         = http://doc.qt.io/qt-4.8/

     ...

Это гарантирует, что всякий раз, когда используется qt.index, для создания ссылок, например, на классы Qt, базовый URL будет http://doc.qt.io/qt-4.8/.

См. также индексы.

Как поддерживать производные проекты

Эта функция использует исчерпывающие индексы, сгенерированные QDoc при создании документации справки Qt.

Например, qtgui.qdocconf (файл конфигурации для Qt) содержит следующие определения переменных:

project     = Qt
description = Qt Reference Documentation
url         = http://doc.qt.io/qt-4.8/

...

Имя переменной project используется для формирования имени файла индексного файла; в этом случае создается файл qt.index. url хранится в файле индекса. После этого QDoc будет использовать его в качестве базового URL при построении ссылок на классы, функции и другие элементы, перечисленные в индексе.