diff options
author | Jerome Pasion <jerome.pasion@qt.io> | 2020-11-11 17:23:18 +0100 |
---|---|---|
committer | Jerome Pasion <jerome.pasion@qt.io> | 2020-11-17 20:16:12 +0100 |
commit | d4b3989818e85b1e1f3183bef2711e125fbe76ca (patch) | |
tree | fe4d940d588be1a33ec06a60ce163f4d5a873cf4 /src/concurrent | |
parent | 4f6c5d83d09881a8432873487eab44b88eabec9e (diff) |
Update landing pages and module pages in qtbase
-Qt SQL, Qt D-BUS, Qt GUI, Qt OpenGL, Qt Widgets,
Qt Test, Qt Concurrent, Qt XML, Qt Network, Qt Core
-language edits for consistency, add links
Task-number: QTBUG-87155
Change-Id: Ic61350c9fa15090c802a42d8e9116219591eba73
Reviewed-by: Paul Wicking <paul.wicking@qt.io>
Diffstat (limited to 'src/concurrent')
-rw-r--r-- | src/concurrent/doc/src/qtconcurrent-index.qdoc | 52 | ||||
-rw-r--r-- | src/concurrent/doc/src/qtconcurrent-module.qdoc | 5 |
2 files changed, 29 insertions, 28 deletions
diff --git a/src/concurrent/doc/src/qtconcurrent-index.qdoc b/src/concurrent/doc/src/qtconcurrent-index.qdoc index e6e09b0ae6..49d7dd478c 100644 --- a/src/concurrent/doc/src/qtconcurrent-index.qdoc +++ b/src/concurrent/doc/src/qtconcurrent-index.qdoc @@ -31,26 +31,17 @@ \brief The Qt Concurrent module contains functionality to support concurrent execution of program code. - \include module-use.qdocinc using qt module - \snippet snippets/CMakeLists.txt cmake_use - See also the \l {Build with CMake} overview. - - \include module-use.qdocinc building with qmake - \snippet snippets/snippets.pro qmake_use - - \section1 Getting Started - - The QtConcurrent namespace provides high-level APIs that make it + The Qt Concurrent module provides high-level APIs that make it possible to write multi-threaded programs without using low-level threading primitives such as mutexes, read-write locks, wait - conditions, or semaphores. Programs written with QtConcurrent + conditions, or semaphores. Programs written with Qt Concurrent automatically adjust the number of threads used according to the number of processor cores available. This means that applications written today will continue to scale when deployed on multi-core systems in the future. - QtConcurrent includes functional programming style APIs for + Qt Concurrent includes functional programming style APIs for parallel list processing, including a MapReduce and FilterReduce implementation for shared-memory (non-distributed) systems, and classes for managing asynchronous computations in GUI @@ -103,15 +94,16 @@ \li QFutureSynchronizer is a convenience class that automatically synchronizes several QFutures. - \li QPromise provides a way to report progress and results of the asynchronous - computation to QFuture. Allows suspending or canceling the task when - requested by QFuture. + \li QPromise provides a way to report progress and results of the + asynchronous computation to QFuture. Allows suspending or canceling the task + when requested by QFuture. \endlist Qt Concurrent supports several STL-compatible container and iterator types, but works best with Qt containers that have random-access iterators, such as - QList. The map and filter functions accept both containers and begin/end iterators. + QList. The map and filter functions accept both containers and begin/end + iterators. STL Iterator support overview: @@ -142,16 +134,25 @@ \li Supported and Recommended \endtable - Random access iterators can be faster in cases where Qt Concurrent is iterating - over a large number of lightweight items, since they allow skipping to any point - in the container. In addition, using random access iterators allows Qt Concurrent - to provide progress information trough QFuture::progressValue() and - QFutureWatcher::progressValueChanged(). + Random access iterators can be faster in cases where Qt Concurrent is + iterating over a large number of lightweight items, since they allow + skipping to any point in the container. In addition, using random access + iterators allows Qt Concurrent to provide progress information trough + QFuture::progressValue() and QFutureWatcher::progressValueChanged(). The non in-place modifying functions such as mapped() and filtered() makes a - copy of the container when called. If you are using STL containers this copy operation - might take some time, in this case we recommend specifying the begin and end iterators - for the container instead. + copy of the container when called. If you are using STL containers this copy + operation might take some time, in this case we recommend specifying the + begin and end iterators for the container instead. + + + \include module-use.qdocinc using qt module + \snippet snippets/CMakeLists.txt cmake_use + + See also the \l {Build with CMake} overview. + + \include module-use.qdocinc building with qmake + \snippet snippets/snippets.pro qmake_use \section1 Module Evolution \l{Changes to Qt Concurrent} lists important changes in the module API @@ -159,7 +160,8 @@ \section1 Licenses - The Qt Concurrent module is available under commercial licenses from \l{The Qt Company}. + The Qt Concurrent module is available under commercial licenses from + \l{The Qt Company}. In addition, it is available under free software licenses: The \l{GNU Lesser General Public License, version 3}, or the \l{GNU General Public License, version 2}. diff --git a/src/concurrent/doc/src/qtconcurrent-module.qdoc b/src/concurrent/doc/src/qtconcurrent-module.qdoc index 72bf3f45d7..31476ba522 100644 --- a/src/concurrent/doc/src/qtconcurrent-module.qdoc +++ b/src/concurrent/doc/src/qtconcurrent-module.qdoc @@ -1,6 +1,6 @@ /**************************************************************************** ** -** Copyright (C) 2016 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. @@ -34,6 +34,5 @@ \qtcmakepackage Concurrent \qtvariable concurrent - The Qt Concurrent module extends the basic threading support found in \l{Qt Core} module and - simplifies the development of code that can be executed in parallel on all available CPU cores. + The \l{Qt Concurrent} page contains information about how to use the module. */ |