From cd090868f0e66cba1138e52eeb956cfa22e2d9c3 Mon Sep 17 00:00:00 2001 From: Ivan Solovev Date: Mon, 20 Feb 2023 17:16:28 +0100 Subject: [PATCH] Add QtConcurrent Examples page MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The QtConcurrent examples were only discoverable from the "All Qt Examples" page, which was very inconvenient. This patch adds a separate page for all Qt Concurrent examples, and links to it from the module's main page. Change-Id: Iecabd9e21033605c1ec74232ce4f3d68b0c78d82 Reviewed-by: MÃ¥rten Nordheim Reviewed-by: Jaishree Vyas (cherry picked from commit 2a4c64cbedad0db25c057456491df6ce86beeee7) Reviewed-by: Qt Cherry-pick Bot --- src/concurrent/doc/qtconcurrent.qdocconf | 5 ++++- src/concurrent/doc/src/qtconcurrent-examples.qdoc | 14 ++++++++++++++ src/concurrent/doc/src/qtconcurrent-index.qdoc | 6 ++++++ 3 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 src/concurrent/doc/src/qtconcurrent-examples.qdoc diff --git a/src/concurrent/doc/qtconcurrent.qdocconf b/src/concurrent/doc/qtconcurrent.qdocconf index 9e8b280f0b8..419ca1f801e 100644 --- a/src/concurrent/doc/qtconcurrent.qdocconf +++ b/src/concurrent/doc/qtconcurrent.qdocconf @@ -15,11 +15,14 @@ qhp.QtConcurrent.virtualFolder = qtconcurrent qhp.QtConcurrent.indexTitle = Qt Concurrent qhp.QtConcurrent.indexRoot = -qhp.QtConcurrent.subprojects = classes +qhp.QtConcurrent.subprojects = classes examples qhp.QtConcurrent.subprojects.classes.title = C++ Classes qhp.QtConcurrent.subprojects.classes.indexTitle = Qt Concurrent C++ Classes qhp.QtConcurrent.subprojects.classes.selectors = class fake:headerfile qhp.QtConcurrent.subprojects.classes.sortPages = true +qhp.QtConcurrent.subprojects.examples.title = Qt Concurrent Examples +qhp.QtConcurrent.subprojects.examples.indexTitle = Qt Concurrent Examples +qhp.QtConcurrent.subprojects.examples.selectors = fake:example tagfile = ../../../doc/qtconcurrent/qtconcurrent.tags diff --git a/src/concurrent/doc/src/qtconcurrent-examples.qdoc b/src/concurrent/doc/src/qtconcurrent-examples.qdoc new file mode 100644 index 00000000000..06705cca1bb --- /dev/null +++ b/src/concurrent/doc/src/qtconcurrent-examples.qdoc @@ -0,0 +1,14 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \group qtconcurrentexamples + \title Qt Concurrent Examples + \brief Examples for the Qt Concurrent module + \ingroup all-examples + \ingroup qtconcurrent + + The list of \l {Qt Concurrent} examples demonstrating how to use + Qt Concurrent API from C++. + +*/ diff --git a/src/concurrent/doc/src/qtconcurrent-index.qdoc b/src/concurrent/doc/src/qtconcurrent-index.qdoc index 368f94fb696..5acf19e134e 100644 --- a/src/concurrent/doc/src/qtconcurrent-index.qdoc +++ b/src/concurrent/doc/src/qtconcurrent-index.qdoc @@ -130,6 +130,12 @@ \include module-use.qdocinc building with qmake \snippet snippets/snippets.pro qmake_use + \section1 Examples + + \list + \li \l {Qt Concurrent Examples} + \endlist + \section1 Module Evolution \l{Changes to Qt Concurrent} lists important changes in the module API and functionality that were done for the Qt 6 series of Qt.