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/qtconcurrentmap.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/qtconcurrentmap.cpp')
| -rw-r--r-- | src/concurrent/qtconcurrentmap.cpp | 20 |
1 files changed, 3 insertions, 17 deletions
diff --git a/src/concurrent/qtconcurrentmap.cpp b/src/concurrent/qtconcurrentmap.cpp index 5233a9db45..fc904a4d59 100644 --- a/src/concurrent/qtconcurrentmap.cpp +++ b/src/concurrent/qtconcurrentmap.cpp @@ -68,14 +68,10 @@ */ /*! - \headerfile <QtConcurrentMap> + \page qtconcurrentmap.html \title Concurrent Map and Map-Reduce \ingroup thread - \brief The <QtConcurrentMap> header provides concurrent Map and MapReduce. - - These functions are a part of the \l {Qt Concurrent} framework. - The QtConcurrent::map(), QtConcurrent::mapped() and QtConcurrent::mappedReduced() functions run computations in parallel on the items in a sequence such as a QList or a QVector. QtConcurrent::map() @@ -83,6 +79,8 @@ sequence containing the modified content, and QtConcurrent::mappedReduced() returns a single result. + These functions are a part of the \l {Qt Concurrent} framework. + Each of the above functions has a blocking variant that returns the final result instead of a QFuture. You use them in the same way as the asynchronous variants. @@ -235,7 +233,6 @@ /*! \fn QFuture<void> QtConcurrent::map(Sequence &sequence, MapFunction function) - \relates <QtConcurrentMap> Calls \a function once for each item in \a sequence. The \a function is passed a reference to the item, so that any modifications done to the item @@ -244,7 +241,6 @@ /*! \fn QFuture<void> QtConcurrent::map(Iterator begin, Iterator end, MapFunction function) - \relates <QtConcurrentMap> Calls \a function once for each item from \a begin to \a end. The \a function is passed a reference to the item, so that any modifications @@ -253,7 +249,6 @@ /*! \fn QFuture<T> QtConcurrent::mapped(const Sequence &sequence, MapFunction function) - \relates <QtConcurrentMap> Calls \a function once for each item in \a sequence and returns a future with each mapped item as a result. You can use QFuture::const_iterator or @@ -262,7 +257,6 @@ /*! \fn QFuture<T> QtConcurrent::mapped(ConstIterator begin, ConstIterator end, MapFunction function) - \relates <QtConcurrentMap> Calls \a function once for each item from \a begin to \a end and returns a future with each mapped item as a result. You can use @@ -274,8 +268,6 @@ MapFunction mapFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions) - \relates <QtConcurrentMap> - Calls \a mapFunction once for each item in \a sequence. The return value of each \a mapFunction is passed to \a reduceFunction. @@ -289,8 +281,6 @@ ConstIterator end, MapFunction mapFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions) - \relates <QtConcurrentMap> - Calls \a mapFunction once for each item from \a begin to \a end. The return value of each \a mapFunction is passed to \a reduceFunction. @@ -357,8 +347,6 @@ /*! \fn T QtConcurrent::blockingMappedReduced(const Sequence &sequence, MapFunction mapFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions) - \relates <QtConcurrentMap> - Calls \a mapFunction once for each item in \a sequence. The return value of each \a mapFunction is passed to \a reduceFunction. @@ -374,8 +362,6 @@ /*! \fn T QtConcurrent::blockingMappedReduced(ConstIterator begin, ConstIterator end, MapFunction mapFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions) - \relates <QtConcurrentMap> - Calls \a mapFunction once for each item from \a begin to \a end. The return value of each \a mapFunction is passed to \a reduceFunction. |