summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorKai Köhne <kai.koehne@qt.io>2021-09-24 07:52:38 +0200
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2021-10-04 13:55:23 +0000
commitee9282ef17150dd31e4046ee85eaf7220ab4d9b3 (patch)
treefeaeca117b7e8348c59496b54cd251302527e2f0 /src
parenta90ca623f487ed2ac9cfa66393168d7da34675a6 (diff)
Doc: Add overview pages to CMake API
So far the pages were only 'rooted' in the separate qtcmake documentation. Let them have a page per module too, so that it's easy to navigate. At the same time rename the cmake-macros-qtcore group to cmake-commands-qtcore. This will require a fixup in qtdoc repository. Change-Id: Ifc09b27a6c220b5feab64686ca47c60d3342e71a Reviewed-by: Paul Wicking <paul.wicking@qt.io> (cherry picked from commit e0ecb0ded21082f4e00ee77411339009cb1294a4) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'src')
-rw-r--r--src/corelib/doc/src/cmake/cmake-commands.qdoc40
-rw-r--r--src/corelib/doc/src/cmake/cmake-properties.qdoc10
-rw-r--r--src/corelib/doc/src/cmake/cmake-variables.qdoc14
-rw-r--r--src/corelib/doc/src/cmake/qt_add_big_resources.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_executable.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_library.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_plugin.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_add_resources.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_finalize_target.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_generate_moc.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_import_plugins.qdoc2
-rw-r--r--src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc2
-rw-r--r--src/corelib/doc/src/qtcore-index.qdoc6
-rw-r--r--src/dbus/doc/src/qtdbus-cmake.qdoc14
-rw-r--r--src/dbus/doc/src/qtdbus-index.qdoc1
21 files changed, 100 insertions, 15 deletions
diff --git a/src/corelib/doc/src/cmake/cmake-commands.qdoc b/src/corelib/doc/src/cmake/cmake-commands.qdoc
new file mode 100644
index 0000000000..63edcbe10d
--- /dev/null
+++ b/src/corelib/doc/src/cmake/cmake-commands.qdoc
@@ -0,0 +1,40 @@
+/****************************************************************************
+**
+** Copyright (C) 2021 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+\group cmake-commands-qtcore
+\title CMake Commands in Qt6 Core
+
+The following CMake commands are defined when Qt6::Core is loaded, for instance
+with
+
+\code
+find_package(Qt6 COMPONENTS Core REQUIRED)
+\endcode
+
+\sa{CMake Command Reference}
+*/
diff --git a/src/corelib/doc/src/cmake/cmake-properties.qdoc b/src/corelib/doc/src/cmake/cmake-properties.qdoc
index b5db780fde..7b8dae7ee8 100644
--- a/src/corelib/doc/src/cmake/cmake-properties.qdoc
+++ b/src/corelib/doc/src/cmake/cmake-properties.qdoc
@@ -26,6 +26,16 @@
****************************************************************************/
/*!
+\group cmake-target-properties-qtcore
+\title CMake Target Properties in Qt6 Core
+
+\l{CMake Commands in Qt6 Core}{CMake Commands} know about the following CMake
+target properties:
+
+\sa{CMake Property Reference}
+*/
+
+/*!
\page cmake-target-property-QT_ANDROID_DEPLOYMENT_DEPENDENCIES.html
\ingroup cmake-properties-qtcore
\ingroup cmake-target-properties-qtcore
diff --git a/src/corelib/doc/src/cmake/cmake-variables.qdoc b/src/corelib/doc/src/cmake/cmake-variables.qdoc
index 52a25956f7..d6feb215a3 100644
--- a/src/corelib/doc/src/cmake/cmake-variables.qdoc
+++ b/src/corelib/doc/src/cmake/cmake-variables.qdoc
@@ -26,6 +26,20 @@
****************************************************************************/
/*!
+\group cmake-variables-qtcore
+\title CMake Variables in Qt6 Core
+
+The following CMake variables are defined when Qt6::Core is loaded, for instance
+with
+
+\badcode
+find_package(Qt6 COMPONENTS Core REQUIRED)
+\endcode
+
+\sa{CMake Variable Reference}
+*/
+
+*/*!
\page cmake-variable-ANDROID_NDK_HOST_SYSTEM_NAME.html
\ingroup cmake-variables
\ingroup cmake-variables-qtcore
diff --git a/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc
index bb35d45cc3..d77ff90b48 100644
--- a/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_big_resources.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_add_bigresources.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_add_big_resources
\target qt6_add_big_resources
diff --git a/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc
index 38c59c4174..b17a3a474b 100644
--- a/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_add_binary_resources.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_add_binary_resources
\target qt6_add_binary_resources
diff --git a/src/corelib/doc/src/cmake/qt_add_executable.qdoc b/src/corelib/doc/src/cmake/qt_add_executable.qdoc
index 95bd9ee9bc..4a807ecb7c 100644
--- a/src/corelib/doc/src/cmake/qt_add_executable.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_executable.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_add_executable.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_add_executable
\target qt6_add_executable
diff --git a/src/corelib/doc/src/cmake/qt_add_library.qdoc b/src/corelib/doc/src/cmake/qt_add_library.qdoc
index ffb50025f7..b39c197a8f 100644
--- a/src/corelib/doc/src/cmake/qt_add_library.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_library.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_add_library.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_add_library
\target qt6_add_library
diff --git a/src/corelib/doc/src/cmake/qt_add_plugin.qdoc b/src/corelib/doc/src/cmake/qt_add_plugin.qdoc
index 9954ef341d..9bd08c20f4 100644
--- a/src/corelib/doc/src/cmake/qt_add_plugin.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_plugin.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_add_plugin.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_add_plugin
\target qt6_add_plugin
diff --git a/src/corelib/doc/src/cmake/qt_add_resources.qdoc b/src/corelib/doc/src/cmake/qt_add_resources.qdoc
index cd6c8ce42e..f0a6ff860e 100644
--- a/src/corelib/doc/src/cmake/qt_add_resources.qdoc
+++ b/src/corelib/doc/src/cmake/qt_add_resources.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_add_resources.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_add_resources
\target qt6_add_resources
diff --git a/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc b/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc
index f3021602a5..de88676d25 100644
--- a/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc
+++ b/src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_allow_non_utf8_sources.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_allow_non_utf8_sources
\target qt6_allow_non_utf8_sources
diff --git a/src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc b/src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc
index fd2e531461..d88dafcb07 100644
--- a/src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc
+++ b/src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_android_add_apk_target.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_android_add_apk_target
\target qt6_android_add_apk_target
diff --git a/src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc b/src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc
index c6f912cce9..8945813cb1 100644
--- a/src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc
+++ b/src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_android_apply_arch_suffix.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_android_apply_arch_suffix
\target qt6_android_apply_arch_suffix
diff --git a/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc b/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc
index 80a9d89919..fdfec1444f 100644
--- a/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc
+++ b/src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_android_generate_deployment_settings.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_android_generate_deployment_settings
\target qt6_android_generate_deployment_settings
diff --git a/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc b/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc
index df93117819..a30cfca3f9 100644
--- a/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc
+++ b/src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_disable_unicode_defines.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_disable_unicode_defines
\target qt6_disable_unicode_defines
diff --git a/src/corelib/doc/src/cmake/qt_finalize_target.qdoc b/src/corelib/doc/src/cmake/qt_finalize_target.qdoc
index 9aee8c0b0e..d72bc4fd8f 100644
--- a/src/corelib/doc/src/cmake/qt_finalize_target.qdoc
+++ b/src/corelib/doc/src/cmake/qt_finalize_target.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_finalize_target.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_finalize_target
\target qt6_finalize_target
diff --git a/src/corelib/doc/src/cmake/qt_generate_moc.qdoc b/src/corelib/doc/src/cmake/qt_generate_moc.qdoc
index e3ee021b5a..2c37bb58c9 100644
--- a/src/corelib/doc/src/cmake/qt_generate_moc.qdoc
+++ b/src/corelib/doc/src/cmake/qt_generate_moc.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_generate_moc.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_generate_moc
\target qt6_generate_moc
diff --git a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
index dcb0c4e984..f7922ae103 100644
--- a/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
+++ b/src/corelib/doc/src/cmake/qt_import_plugins.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_import_plugins.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_import_plugins
\target qt6_import_plugins
diff --git a/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc b/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc
index acbbeae2e3..2fee20d536 100644
--- a/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc
+++ b/src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc
@@ -27,7 +27,7 @@
/*!
\page qt_wrap_cpp.html
-\ingroup cmake-macros-qtcore
+\ingroup cmake-commands-qtcore
\title qt_wrap_cpp
\target qt6_wrap_cpp
diff --git a/src/corelib/doc/src/qtcore-index.qdoc b/src/corelib/doc/src/qtcore-index.qdoc
index c74f173562..390c44ab63 100644
--- a/src/corelib/doc/src/qtcore-index.qdoc
+++ b/src/corelib/doc/src/qtcore-index.qdoc
@@ -136,6 +136,12 @@
\li \l{Input/Output and Networking}{Input/Output Classes}
\li \l{Event Classes}
\endlist
+ \li CMake API
+ \list
+ \li \l{CMake Commands in Qt6 Core}{CMake Commands}
+ \li \l{CMake Variables in Qt6 Core}{CMake Variables}
+ \li \l{CMake Target Properties in Qt6 Core}{CMake Target Properties}
+ \endlist
\endlist
*/
diff --git a/src/dbus/doc/src/qtdbus-cmake.qdoc b/src/dbus/doc/src/qtdbus-cmake.qdoc
index 6968bb5a69..a315fe47b1 100644
--- a/src/dbus/doc/src/qtdbus-cmake.qdoc
+++ b/src/dbus/doc/src/qtdbus-cmake.qdoc
@@ -26,6 +26,20 @@
****************************************************************************/
/*!
+\group cmake-commands-qtdbus
+\title CMake Commands in Qt6 DBus
+
+The following CMake commands are defined when Qt6::DBus is loaded, for instance
+with
+
+\code
+find_package(Qt6 COMPONENTS DBus REQUIRED)
+\endcode
+
+\sa{CMake Command Reference}
+*/
+
+/*!
\page qtdbus-cmake-qt-add-dbus-interface.html
\ingroup cmake-commands-qtdbus
diff --git a/src/dbus/doc/src/qtdbus-index.qdoc b/src/dbus/doc/src/qtdbus-index.qdoc
index afd70c2f7c..dd03ba595f 100644
--- a/src/dbus/doc/src/qtdbus-index.qdoc
+++ b/src/dbus/doc/src/qtdbus-index.qdoc
@@ -239,6 +239,7 @@
\li \l{The Qt D-Bus Type System}
\li \l{Qt D-Bus XML compiler (qdbusxml2cpp)}
\li \l{Qt D-Bus C++ Classes}
+ \li \l{CMake Commands in Qt6 DBus}
\li \l{Qt D-Bus Examples}
\li \l{D-Bus Viewer}
\endlist