From ea0814fb7f15bae1a72565efac1e4422981c318e Mon Sep 17 00:00:00 2001 From: Paul Wicking Date: Wed, 14 Feb 2024 10:12:26 +0100 Subject: [PATCH] Doc: Resolve qdoc link warnings MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Drop link to non-existing documentation. - Reorder links such that the target becomes the text and vice versa. - Use correct link target names. - Add missing qttestlib doc project dependency to qtwidgets. Change-Id: Iaa0ea7b22326c82271b14b17c4b78c3a25a834f1 Reviewed-by: Topi Reiniö (cherry picked from commit f157422c58475b3b818b0dddc31289e7105967c2) Reviewed-by: Qt Cherry-pick Bot --- examples/widgets/doc/src/editabletreemodel.qdoc | 5 +++-- examples/widgets/doc/src/simpletreemodel.qdoc | 5 +++-- src/corelib/doc/src/cmake/policy/qtp0003.qdoc | 4 ++-- src/corelib/doc/src/includes/cmake-deploy-var-usage.qdocinc | 4 ++-- src/dbus/qdbusabstractinterface.cpp | 3 +-- src/widgets/doc/qtwidgets.qdocconf | 3 ++- 6 files changed, 13 insertions(+), 11 deletions(-) diff --git a/examples/widgets/doc/src/editabletreemodel.qdoc b/examples/widgets/doc/src/editabletreemodel.qdoc index 22ff7b574e3..15df678c878 100644 --- a/examples/widgets/doc/src/editabletreemodel.qdoc +++ b/examples/widgets/doc/src/editabletreemodel.qdoc @@ -422,8 +422,9 @@ \section1 Testing the model Correctly implementing an item model can be challenging. The class - \l QAbstractItemModelTester from the \l{Qt Test} module checks for model - consistency, like the model index creation and parent-child relationships. + \l [QtTest] QAbstractItemModelTester from the \l [QtTest]{Qt Test} module + checks for model consistency, like the model index creation and + parent-child relationships. You can test your model by just passing a model instance to the class constructor, for instance as part of a Qt unit test: diff --git a/examples/widgets/doc/src/simpletreemodel.qdoc b/examples/widgets/doc/src/simpletreemodel.qdoc index 10e79e28452..aa12a9585ff 100644 --- a/examples/widgets/doc/src/simpletreemodel.qdoc +++ b/examples/widgets/doc/src/simpletreemodel.qdoc @@ -323,8 +323,9 @@ \section1 Testing the model Correctly implementing an item model can be challenging. The class - \l QAbstractItemModelTester from the \l{Qt Test} module checks for model - consistency, like the model index creation and parent-child relationships. + \l [QtTest] QAbstractItemModelTester from the \l [QtTest] {Qt Test} module + checks for model consistency, like the model index creation and + parent-child relationships. You can test your model by just passing a model instance to the class constructor, for instance as part of a Qt unit test: diff --git a/src/corelib/doc/src/cmake/policy/qtp0003.qdoc b/src/corelib/doc/src/cmake/policy/qtp0003.qdoc index 70aef6466c9..bf11b6f8b56 100644 --- a/src/corelib/doc/src/cmake/policy/qtp0003.qdoc +++ b/src/corelib/doc/src/cmake/policy/qtp0003.qdoc @@ -11,14 +11,14 @@ \summary {Consider the BUILD_SHARED_LIBS value when creating Qt libraries.} This policy was introduced in Qt 6.7. The policy affects the default type of the -libraries created using \l {Qt CMake API}{CMake Commands in Qt6 Core}, like +libraries created using \l {CMake Commands in Qt6 Core}{Qt CMake API}, like \l {qt_add_library}, \l{qt_add_plugin}, \l{qt_add_qml_module}. If the policy is set to \c OLD, the default library type that is selected is aligned with the Qt build type, either \c shared or \c static. If the policy is set to \c NEW, the library type is selected according to the -\l {BUILD_SHARED_LIBS}{CMake BUILD_SHARED_LIBS Documentation} value if it's set. +\l {CMake BUILD_SHARED_LIBS Documentation}{BUILD_SHARED_LIBS} value if it's set. If \c BUILD_SHARED_LIBS is not set, the default library type falls back to the Qt build type. diff --git a/src/corelib/doc/src/includes/cmake-deploy-var-usage.qdocinc b/src/corelib/doc/src/includes/cmake-deploy-var-usage.qdocinc index c8b67b52b9d..27e04b5b080 100644 --- a/src/corelib/doc/src/includes/cmake-deploy-var-usage.qdocinc +++ b/src/corelib/doc/src/includes/cmake-deploy-var-usage.qdocinc @@ -2,5 +2,5 @@ This variable is defined by the script named by \l QT_DEPLOY_SUPPORT. It should only be used as part of deployment during installation or a post-build rule. \note This is a low-level deployment API variable, and should only be used in -advanced use-cases that are not covered by the higher-level API commands like -\l{qt_generate_app_deploy_script}. +advanced use-cases that are not covered by the higher-level API commands, like +\l{qt_generate_deploy_app_script}. diff --git a/src/dbus/qdbusabstractinterface.cpp b/src/dbus/qdbusabstractinterface.cpp index 8e34fa40e7f..0c6dbf1b3b7 100644 --- a/src/dbus/qdbusabstractinterface.cpp +++ b/src/dbus/qdbusabstractinterface.cpp @@ -412,8 +412,7 @@ int QDBusAbstractInterface::timeout() const The default is \c false. \since 6.7 - \sa QDBusMessage::setInteractiveAuthorizationAllowed(), - interactiveAuthorizationAllowed() + \sa QDBusMessage::setInteractiveAuthorizationAllowed() */ void QDBusAbstractInterface::setInteractiveAuthorizationAllowed(bool enable) { diff --git a/src/widgets/doc/qtwidgets.qdocconf b/src/widgets/doc/qtwidgets.qdocconf index 2155e43f997..5f68179a367 100644 --- a/src/widgets/doc/qtwidgets.qdocconf +++ b/src/widgets/doc/qtwidgets.qdocconf @@ -39,7 +39,8 @@ depends += \ qtlinguist \ qthelp \ qtopengl \ - qtshadertools + qtshadertools \ + qttestlib headerdirs += ..