AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Add overview pages to CMake API

Browse Source 
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.

Pick-to: 6.2
Change-Id: Ifc09b27a6c220b5feab64686ca47c60d3342e71a
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
This commit is contained in:
Kai Köhne 2021-09-24 07:52:38 +02:00
parent d78245ce8f
commit e0ecb0ded2
21 changed files with 100 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
src/corelib/doc/src/cmake/cmake-commands.qdoc Normal file
View File

@ -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}
*/

10
src/corelib/doc/src/cmake/cmake-properties.qdoc
View File

@ -25,6 +25,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

14
src/corelib/doc/src/cmake/cmake-variables.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_big_resources.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_binary_resources.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_executable.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_library.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_plugin.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_add_resources.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_allow_non_utf8_sources.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_android_add_apk_target.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_android_apply_arch_suffix.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_android_generate_deployment_settings.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_disable_unicode_defines.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_finalize_target.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_generate_moc.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_import_plugins.qdoc
View File

@ -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

2
src/corelib/doc/src/cmake/qt_wrap_cpp.qdoc
View File

@ -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

6
src/corelib/doc/src/qtcore-index.qdoc
View File

@ -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
*/

14
src/dbus/doc/src/qtdbus-cmake.qdoc
View File

@ -25,6 +25,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

1
src/dbus/doc/src/qtdbus-index.qdoc
View File

@ -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