summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Koehne <kai.koehne@qt.io>2020-11-18 14:26:47 +0100
committerQt Cherry-pick Bot <cherrypick_bot@qt-project.org>2020-11-24 05:14:05 +0000
commit5c2f2deef191e6157c9dd3edcc19c4cbec752fc2 (patch)
treee6d47e2991865a1c00b32f1331783d9090298670
parent1ba2f6b2d2e67790dfb01abbe933a7143a9d1207 (diff)
Doc: Update CMake functions in Qt Widgets for Qt 6
Change-Id: I4110e8695c75c40cec6f94bb94879b07282b29d3 Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io> (cherry picked from commit c082213556991c6619ef2d2c00a7042406f867a7) Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
-rw-r--r--src/widgets/doc/snippets/cmake-macros/examples.cmake6
-rw-r--r--src/widgets/doc/src/cmake-macros.qdoc46
-rw-r--r--src/widgets/doc/src/includes/qt_wrap_ui.qdocinc40
3 files changed, 12 insertions, 80 deletions
diff --git a/src/widgets/doc/snippets/cmake-macros/examples.cmake b/src/widgets/doc/snippets/cmake-macros/examples.cmake
index 88cf79ea7b..e1f9f6a277 100644
--- a/src/widgets/doc/snippets/cmake-macros/examples.cmake
+++ b/src/widgets/doc/snippets/cmake-macros/examples.cmake
@@ -1,9 +1,3 @@
-#! [qt5_wrap_ui]
-set(SOURCES mainwindow.cpp main.cpp)
-qt5_wrap_ui(SOURCES mainwindow.ui)
-add_executable(myapp ${SOURCES})
-#! [qt5_wrap_ui]
-
#! [qt_wrap_ui]
set(SOURCES mainwindow.cpp main.cpp)
qt_wrap_ui(SOURCES mainwindow.ui)
diff --git a/src/widgets/doc/src/cmake-macros.qdoc b/src/widgets/doc/src/cmake-macros.qdoc
index 00ba776d5f..108d63a7dd 100644
--- a/src/widgets/doc/src/cmake-macros.qdoc
+++ b/src/widgets/doc/src/cmake-macros.qdoc
@@ -26,40 +26,11 @@
****************************************************************************/
/*!
-\page qtwidgets-cmake-qt5-wrap-ui.html
-\ingroup cmake-macros-qtwidgets
-
-\title qt5_wrap_ui
-
-\brief Creates sources for \c{.ui} files.
-
-\section1 Synopsis
-
-\badcode
-qt5_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
- [OPTIONS ...])
-\endcode
-
-\section1 Description
-
-\include includes/qt_wrap_ui.qdocinc description
-
-\note For compatibility with Qt 6, the command is also available under the name \l qt_wrap_ui.
-
-\section1 Options
-
-\include includes/qt_wrap_ui.qdocinc options
-
-\section1 Examples
-
-\snippet cmake-macros/examples.cmake qt5_wrap_ui
-*/
-
-/*!
-\page qtwidgets-cmake-qt-wrap-ui.html
+\page qt_wrap_ui.html
\ingroup cmake-macros-qtwidgets
\title qt_wrap_ui
+\target qt6_wrap_ui
\brief Creates sources for \c{.ui} files.
@@ -68,17 +39,24 @@ qt5_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
\badcode
qt_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
[OPTIONS ...])
+
+qt6_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
+ [OPTIONS ...])
\endcode
\section1 Description
-\include includes/qt_wrap_ui.qdocinc description
+Creates rules for calling the \l{uic}{User Interface Compiler (uic)} on the given
+\c{.ui} files. For each input file, an header file is generated in the build
+directory. The paths of the generated header files are added to \c{<VAR>}.
-This command was introduced in Qt 5.15. You can use \l qt5_wrap_ui in older versions of Qt.
+\note This is a low-level macro. See the \l{CMake AUTOUIC Documentation} for a
+more convenient way to process \c{.ui} files with \c{uic}.
\section1 Options
-\include includes/qt_wrap_ui.qdocinc options
+You can set additional \c{OPTIONS} that should be added to the \c{uic} calls.
+You can find possible options in the \l{uic}{uic documentation}.
\section1 Examples
diff --git a/src/widgets/doc/src/includes/qt_wrap_ui.qdocinc b/src/widgets/doc/src/includes/qt_wrap_ui.qdocinc
deleted file mode 100644
index 52bbff455a..0000000000
--- a/src/widgets/doc/src/includes/qt_wrap_ui.qdocinc
+++ /dev/null
@@ -1,40 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2020 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$
-**
-****************************************************************************/
-
-//! [description]
-Creates rules for calling the \l{uic}{User Interface Compiler (uic)} on the given
-\c{.ui} files. For each input file, an header file is generated in the build
-directory. The paths of the generated header files are added to \c{<VAR>}.
-
-\note This is a low-level macro. See the \l{CMake AUTOUIC Documentation} for a
-more convenient way to process \c{.ui} files with \c{uic}.
-//! [description]
-
-//! [options]
-You can set additional \c{OPTIONS} that should be added to the \c{uic} calls.
-You can find possible options in the \l{uic}{uic documentation}.
-//! [options]