From 55b470e41120a5878a7cdbb792f12e63e603ea68 Mon Sep 17 00:00:00 2001
From: Kai Koehne <kai.koehne@qt.io>
Date: Wed, 22 Apr 2020 16:49:34 +0200
Subject: CMake: Document versionless commands

Pick-to: 5.15
Change-Id: I249c10bf3338b08477ce04f7c2d5098390a6f9a0
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
---
 .../doc/snippets/cmake-macros/examples.cmake       |  6 +++
 src/widgets/doc/src/cmake-macros.qdoc              | 44 +++++++++++++++++-----
 src/widgets/doc/src/includes/qt_wrap_ui.qdocinc    | 40 ++++++++++++++++++++
 3 files changed, 81 insertions(+), 9 deletions(-)
 create mode 100644 src/widgets/doc/src/includes/qt_wrap_ui.qdocinc

(limited to 'src/widgets/doc')

diff --git a/src/widgets/doc/snippets/cmake-macros/examples.cmake b/src/widgets/doc/snippets/cmake-macros/examples.cmake
index 61ec7aed54..88cf79ea7b 100644
--- a/src/widgets/doc/snippets/cmake-macros/examples.cmake
+++ b/src/widgets/doc/snippets/cmake-macros/examples.cmake
@@ -3,3 +3,9 @@ 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)
+add_executable(myapp ${SOURCES})
+#! [qt_wrap_ui]
diff --git a/src/widgets/doc/src/cmake-macros.qdoc b/src/widgets/doc/src/cmake-macros.qdoc
index 36579576a9..00ba776d5f 100644
--- a/src/widgets/doc/src/cmake-macros.qdoc
+++ b/src/widgets/doc/src/cmake-macros.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the documentation of the Qt Toolkit.
@@ -37,24 +37,50 @@
 
 \badcode
 qt5_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
-             [OPTIONS ...])
+            [OPTIONS ...])
 \endcode
 
 \section1 Description
 
-Creates rules for calling \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>}.
+\include includes/qt_wrap_ui.qdocinc description
 
-\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}.
+\note For compatibility with Qt 6, the command is also available under the name \l qt_wrap_ui.
 
 \section1 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}.
+\include includes/qt_wrap_ui.qdocinc options
 
 \section1 Examples
 
 \snippet cmake-macros/examples.cmake qt5_wrap_ui
 */
+
+/*!
+\page qtwidgets-cmake-qt-wrap-ui.html
+\ingroup cmake-macros-qtwidgets
+
+\title qt_wrap_ui
+
+\brief Creates sources for \c{.ui} files.
+
+\section1 Synopsis
+
+\badcode
+qt_wrap_ui(<VAR> ui_file1 [ui_file2 ...]
+           [OPTIONS ...])
+\endcode
+
+\section1 Description
+
+\include includes/qt_wrap_ui.qdocinc description
+
+This command was introduced in Qt 5.15. You can use \l qt5_wrap_ui in older versions of Qt.
+
+\section1 Options
+
+\include includes/qt_wrap_ui.qdocinc options
+
+\section1 Examples
+
+\snippet cmake-macros/examples.cmake qt_wrap_ui
+*/
diff --git a/src/widgets/doc/src/includes/qt_wrap_ui.qdocinc b/src/widgets/doc/src/includes/qt_wrap_ui.qdocinc
new file mode 100644
index 0000000000..52bbff455a
--- /dev/null
+++ b/src/widgets/doc/src/includes/qt_wrap_ui.qdocinc
@@ -0,0 +1,40 @@
+/****************************************************************************
+**
+** 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]
-- 
cgit v1.2.3