Add QtConcurrent Examples page

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.

Pick-to: 6.5
Change-Id: Iecabd9e21033605c1ec74232ce4f3d68b0c78d82
Reviewed-by: Mårten Nordheim <marten.nordheim@qt.io>
Reviewed-by: Jaishree Vyas <jaishree.vyas@qt.io>
This commit is contained in:
Ivan Solovev 2023-02-20 17:16:28 +01:00
parent 6c12ea1d45
commit 2a4c64cbed
3 changed files with 24 additions and 1 deletions

View File

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

View File

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

View File

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