diff options
| author | Sze Howe Koh <szehowe.koh@gmail.com> | 2013-10-24 19:50:12 +0800 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-30 00:34:34 +0100 |
| commit | bec8d2e0891344f44cd2f57b40fdd286c2361b18 (patch) | |
| tree | 5a0cd12714ad9139020d663e6fbdf996d5cb1518 /src/concurrent/qtconcurrentrun.cpp | |
| parent | aceb854bbb6582cbdecb4da94b64782c76a653cb (diff) | |
Doc: Remove unofficial Qt Concurrent headers
<QtConcurrentRun>, <QtConcurrentMap>, and <QtConcurrentFilter> are not
official headers. Developers should use <QtConcurrent> instead.
As a side-effect, this patch also stops the function documentation from
being duplicated (one copy in the QtConcurrent namespace page, one copy
in the \headerfile pages)
(For some reason, \brief doesn't work on standalone pages like these)
Change-Id: I9482f014acf52ba734a3fa597cdcc5931fcd7ecf
Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Reviewed-by: Stephen Kelly <stephen.kelly@kdab.com>
Diffstat (limited to 'src/concurrent/qtconcurrentrun.cpp')
| -rw-r--r-- | src/concurrent/qtconcurrentrun.cpp | 13 |
1 files changed, 4 insertions, 9 deletions
diff --git a/src/concurrent/qtconcurrentrun.cpp b/src/concurrent/qtconcurrentrun.cpp index c60fa14777..c71fc9048f 100644 --- a/src/concurrent/qtconcurrentrun.cpp +++ b/src/concurrent/qtconcurrentrun.cpp @@ -40,19 +40,15 @@ ****************************************************************************/ /*! - \headerfile <QtConcurrentRun> - \title Asynchronous Run - - \brief The <QtConcurrentRun> header provides a way to run a function in a - separate thread. - + \page qtconcurrentrun.html + \title Concurrent Run \ingroup thread - This function is a part of the \l {Qt Concurrent} framework. - The QtConcurrent::run() function runs a function in a separate thread. The return value of the function is made available through the QFuture API. + This function is a part of the \l {Qt Concurrent} framework. + \section1 Running a Function in a Separate Thread To run a function in another thread, use QtConcurrent::run(): @@ -133,7 +129,6 @@ /*! \fn QFuture<T> QtConcurrent::run(Function function, ...); - \relates <QtConcurrentRun> Runs \a function in a separate thread. The thread is taken from the global QThreadPool. Note that the function may not run immediately; the function |