支持衍生项目

一些配置变量允许您使用 QDoc 支持基于 Qt 的项目。它们允许您的项目包含指向在线 Qt 文档的链接，这意味着 QDoc 将能够创建对类参考文档的链接，而无需任何显式的链接命令。

description

描述变量存储与相关项目关联的简短描述。

另请参阅 project。

indexes 变量定义了一组加载索引文件的路径。

indexes = \
    $QT_INSTALL_DOCS/qtcore/qtcore.index \
    $SOME_OTHER_PROJECT/doc/foo.index

indexes 变量提供了替代 depends 来定义项目的依赖项。由于提供了直接路径，调用 QDoc 时不需要任何 -indexdir 命令行选项。

可以使用任一变量定义依赖项。Qt 文档仅使用 depends 变量。

另请参阅 depends、project 和 url。

project 变量提供了一个用于与 .qdocconf 文件关联的项目名称。这是一个必须设置的变量，所有项目都必须设置。

项目名称用于生成关联项目的 index 文件名称。

project = QtCreator

这将导致创建一个名为 qtcreator.index 的索引文件。

如果项目名称包含空格或特殊字符，则这些字符在生成的索引文件名称中将替换为连字符 ('-')。

url 变量存储与当前项目关联的文档的基本 URL。

URL 存储在项目的生成索引文件中。当我们单独使用索引时，QDoc 将使用它作为在构成索引中列出的类、函数和其他事物的链接时的基本 URL。

project     = QtCore
description = Qt Core Reference Documentation
url         = https://doc.qt.ac.cn/qt/

...

这确保了每当 QDoc 生成对 Qt Core 模块的实体引用时，基本 URL 是 https://doc.qt.ac.cn/qt/。

url.examples变量保存了与当前项目关联的示例的基本URL。

如果已定义，则在每个示例文档页的末尾生成一个指向示例项目目录的链接。变量url.examples指向与该项目相关的示例的根目录；它可以是一个指向在线存储库的链接（以http://或https://开头），或指向本地文件系统（file://）。

如果没有定义url.examples，则QDoc将输出示例的文件和图像列表。

例如，给定以下定义

url.examples = "https://code.qt.io/cgit/qt/qtbase.git/tree/examples/"
examplesinstallpath = corelib

那么，对于下面的\example命令

/*!
    \example threads/semaphores
    ...
*/

QDoc生成一个链接到https://code.qt.io/cgit/qt/qtbase.git/tree/examples/corelib/threads/semaphores。

如果URL在示例路径之后包含更多组件（例如，查询字符串），则可以使用\1作为路径的占位符

url.examples = "https://code.qt.io/cgit/qt/qtbase.git/tree/examples/\1?h=$QT_VER"
examplesinstallpath = corelib

给定上面的\example命令和假设$QT_VER扩展为5.13，生成的URL为https://code.qt.io/cgit/qt/qtbase.git/tree/examples/corelib/threads/semaphores?h=5.13。

url.examples变量在QDoc版本5.13中引入。

此功能利用QDoc在创建Qt参考文档时生成的全面索引。

例如，qtgui.qdocconf（Qt GUI的配置文件）包含以下变量定义

project     = QtGui
description = Qt GUI Reference Documentation
url         = https://doc.qt.ac.cn/qt/

...

用作索引文件的文件名的变量名是project，在本例中创建了一个名为qtgui.index的文件。在索引文件中存储了url。在此之后，QDoc将使用此作为构造链接到索引中列出的类、函数和其他事物的基URL。