AuroraMiddleware/qt5base-lts
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: Remove unofficial Qt Concurrent headers

Browse Source 
<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>
This commit is contained in:
Sze Howe Koh 2013-10-24 19:50:12 +08:00 committed by The Qt Project
parent aceb854bbb
commit bec8d2e089
3 changed files with 10 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/concurrent/qtconcurrentfilter.cpp
View File

@ -40,15 +40,10 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\headerfile <QtConcurrentFilter> \page qtconcurrentfilter.html
\title Concurrent Filter and Filter-Reduce \title Concurrent Filter and Filter-Reduce
\ingroup thread \ingroup thread
\brief The <QtConcurrentFilter> header provides concurrent Filter and
Filter-Reduce.
These functions are a part of the \l {Qt Concurrent} framework.
The QtConcurrent::filter(), QtConcurrent::filtered() and The QtConcurrent::filter(), QtConcurrent::filtered() and
QtConcurrent::filteredReduced() functions filter items in a sequence such QtConcurrent::filteredReduced() functions filter items in a sequence such
as a QList or a QVector in parallel. QtConcurrent::filter() modifies a as a QList or a QVector in parallel. QtConcurrent::filter() modifies a
@ -56,6 +51,8 @@
containing the filtered content, and QtConcurrent::filteredReduced() containing the filtered content, and QtConcurrent::filteredReduced()
returns a single result. returns a single result.
These functions are a part of the \l {Qt Concurrent} framework.
Each of the above functions have a blocking variant that returns the final Each of the above functions have a blocking variant that returns the final
result instead of a QFuture. You use them in the same way as the result instead of a QFuture. You use them in the same way as the
asynchronous variants. asynchronous variants.
@ -186,7 +183,6 @@
/*! /*!
\fn QFuture<void> QtConcurrent::filter(Sequence &sequence, FilterFunction filterFunction) \fn QFuture<void> QtConcurrent::filter(Sequence &sequence, FilterFunction filterFunction)
\relates <QtConcurrentFilter>
Calls \a filterFunction once for each item in \a sequence. If Calls \a filterFunction once for each item in \a sequence. If
\a filterFunction returns \c true, the item is kept in \a sequence; \a filterFunction returns \c true, the item is kept in \a sequence;
@ -195,7 +191,6 @@
/*! /*!
\fn QFuture<T> QtConcurrent::filtered(const Sequence &sequence, FilterFunction filterFunction) \fn QFuture<T> QtConcurrent::filtered(const Sequence &sequence, FilterFunction filterFunction)
\relates <QtConcurrentFilter>
Calls \a filterFunction once for each item in \a sequence and returns a Calls \a filterFunction once for each item in \a sequence and returns a
new Sequence of kept items. If \a filterFunction returns \c true, a copy of new Sequence of kept items. If \a filterFunction returns \c true, a copy of
@ -205,7 +200,6 @@
/*! /*!
\fn QFuture<T> QtConcurrent::filtered(ConstIterator begin, ConstIterator end, FilterFunction filterFunction) \fn QFuture<T> QtConcurrent::filtered(ConstIterator begin, ConstIterator end, FilterFunction filterFunction)
\relates <QtConcurrentFilter>
Calls \a filterFunction once for each item from \a begin to \a end and Calls \a filterFunction once for each item from \a begin to \a end and
returns a new Sequence of kept items. If \a filterFunction returns \c true, a returns a new Sequence of kept items. If \a filterFunction returns \c true, a
@ -215,7 +209,6 @@
/*! /*!
\fn QFuture<T> QtConcurrent::filteredReduced(const Sequence &sequence, FilterFunction filterFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions) \fn QFuture<T> QtConcurrent::filteredReduced(const Sequence &sequence, FilterFunction filterFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions)
\relates <QtConcurrentFilter>
Calls \a filterFunction once for each item in \a sequence. If Calls \a filterFunction once for each item in \a sequence. If
\a filterFunction returns \c true for an item, that item is then passed to \a filterFunction returns \c true for an item, that item is then passed to
@ -232,7 +225,6 @@
/*! /*!
\fn QFuture<T> QtConcurrent::filteredReduced(ConstIterator begin, ConstIterator end, FilterFunction filterFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions) \fn QFuture<T> QtConcurrent::filteredReduced(ConstIterator begin, ConstIterator end, FilterFunction filterFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions)
\relates <QtConcurrentFilter>
Calls \a filterFunction once for each item from \a begin to \a end. If Calls \a filterFunction once for each item from \a begin to \a end. If
\a filterFunction returns \c true for an item, that item is then passed to \a filterFunction returns \c true for an item, that item is then passed to

20
src/concurrent/qtconcurrentmap.cpp
View File

@ -68,14 +68,10 @@
*/ */
/*! /*!
\headerfile <QtConcurrentMap> \page qtconcurrentmap.html
\title Concurrent Map and Map-Reduce \title Concurrent Map and Map-Reduce
\ingroup thread \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 The QtConcurrent::map(), QtConcurrent::mapped() and
QtConcurrent::mappedReduced() functions run computations in parallel on QtConcurrent::mappedReduced() functions run computations in parallel on
the items in a sequence such as a QList or a QVector. QtConcurrent::map() 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() sequence containing the modified content, and QtConcurrent::mappedReduced()
returns a single result. 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 Each of the above functions has a blocking variant that returns
the final result instead of a QFuture. You use them in the same the final result instead of a QFuture. You use them in the same
way as the asynchronous variants. way as the asynchronous variants.
@ -235,7 +233,6 @@
/*! /*!
\fn QFuture<void> QtConcurrent::map(Sequence &sequence, MapFunction function) \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 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 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) \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 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 \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) \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 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 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) \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 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 future with each mapped item as a result. You can use
@ -274,8 +268,6 @@
MapFunction mapFunction, ReduceFunction reduceFunction, MapFunction mapFunction, ReduceFunction reduceFunction,
QtConcurrent::ReduceOptions reduceOptions) QtConcurrent::ReduceOptions reduceOptions)
\relates <QtConcurrentMap>
Calls \a mapFunction once for each item in \a sequence. The return value of Calls \a mapFunction once for each item in \a sequence. The return value of
each \a mapFunction is passed to \a reduceFunction. each \a mapFunction is passed to \a reduceFunction.
@ -289,8 +281,6 @@
ConstIterator end, MapFunction mapFunction, ReduceFunction reduceFunction, ConstIterator end, MapFunction mapFunction, ReduceFunction reduceFunction,
QtConcurrent::ReduceOptions reduceOptions) QtConcurrent::ReduceOptions reduceOptions)
\relates <QtConcurrentMap>
Calls \a mapFunction once for each item from \a begin to \a end. The return 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. 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) \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 Calls \a mapFunction once for each item in \a sequence. The return value of
each \a mapFunction is passed to \a reduceFunction. 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) \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 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. value of each \a mapFunction is passed to \a reduceFunction.

13
src/concurrent/qtconcurrentrun.cpp
View File

@ -40,19 +40,15 @@
****************************************************************************/ ****************************************************************************/
/*! /*!
\headerfile <QtConcurrentRun> \page qtconcurrentrun.html
\title Asynchronous Run \title Concurrent Run
\brief The <QtConcurrentRun> header provides a way to run a function in a
separate thread.
\ingroup thread \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 QtConcurrent::run() function runs a function in a separate thread.
The return value of the function is made available through the QFuture API. 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 \section1 Running a Function in a Separate Thread
To run a function in another thread, use QtConcurrent::run(): To run a function in another thread, use QtConcurrent::run():
@ -133,7 +129,6 @@
/*! /*!
\fn QFuture<T> QtConcurrent::run(Function function, ...); \fn QFuture<T> QtConcurrent::run(Function function, ...);
\relates <QtConcurrentRun>
Runs \a function in a separate thread. The thread is taken from the global 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 QThreadPool. Note that the function may not run immediately; the function