From d3af09fdb20eef52a85dfedf71517863242a63a0 Mon Sep 17 00:00:00 2001 From: Martin Smith Date: Fri, 4 Aug 2017 14:26:27 +0200 Subject: doc: Fix qdoc errors for \fn commands in QtConcurrent This change updates the \fn commands in the QtConcurrent module, which makes extensive use of templates. Some of the update \fn commands are very long as a result. A few cases of the tag trick were used to fix qdoc errors for some complicated template function signatures that were marked \internal anyway. Change-Id: I8546b89030c51bb9dddf38fa10bc0248d901aa51 Reviewed-by: Martin Smith --- src/concurrent/qtconcurrentmap.cpp | 94 +++++++++++++++++++++++++++++++------- 1 file changed, 78 insertions(+), 16 deletions(-) (limited to 'src/concurrent/qtconcurrentmap.cpp') diff --git a/src/concurrent/qtconcurrentmap.cpp b/src/concurrent/qtconcurrentmap.cpp index 1ba5de355b..9c01b65611 100644 --- a/src/concurrent/qtconcurrentmap.cpp +++ b/src/concurrent/qtconcurrentmap.cpp @@ -52,6 +52,72 @@ \ingroup thread */ +/*! + \enum QtConcurrent::ReduceQueueLimits + \internal + */ + +/*! + \class QtConcurrent::ReduceKernel + \inmodule QtConcurrent + \internal +*/ + +/*! + \class QtConcurrent::SequenceHolder2 + \inmodule QtConcurrent + \internal +*/ + +/*! + \class QtConcurrent::MapKernel + \inmodule QtConcurrent + \internal +*/ + +/*! + \class QtConcurrent::MappedReducedKernel + \inmodule QtConcurrent + \internal +*/ + +/*! + \class QtConcurrent::MappedEachKernel + \inmodule QtConcurrent + \internal +*/ + +/*! + \class QtConcurrent::SequenceHolder1 + \inmodule QtConcurrent + \internal +*/ + +/*! + \fn [qtconcurrentmapkernel-1] ThreadEngineStarter QtConcurrent::startMap(Iterator begin, Iterator end, Functor functor) + \internal +*/ + +/*! + \fn [qtconcurrentmapkernel-2] ThreadEngineStarter QtConcurrent::startMapped(Iterator begin, Iterator end, Functor functor) + \internal +*/ + +/*! + \fn [qtconcurrentmapkernel-3] ThreadEngineStarter QtConcurrent::startMapped(const Sequence &sequence, Functor functor) + \internal +*/ + +/*! + \fn [qtconcurrentmapkernel-4] ThreadEngineStarter QtConcurrent::startMappedReduced(const Sequence & sequence, MapFunctor mapFunctor, ReduceFunctor reduceFunctor, ReduceOptions options) + \internal +*/ + +/*! + \fn [qtconcurrentmapkernel-5] ThreadEngineStarter QtConcurrent::startMappedReduced(Iterator begin, Iterator end, MapFunctor mapFunctor, ReduceFunctor reduceFunctor, ReduceOptions options) + \internal +*/ + /*! \enum QtConcurrent::ReduceOption This enum specifies the order of which results from the map or filter @@ -225,7 +291,7 @@ */ /*! - \fn QFuture QtConcurrent::map(Sequence &sequence, MapFunction function) + \fn template QFuture QtConcurrent::map(Sequence &sequence, MapFunctor function) 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 @@ -235,7 +301,7 @@ */ /*! - \fn QFuture QtConcurrent::map(Iterator begin, Iterator end, MapFunction function) + \fn template QFuture QtConcurrent::map(Iterator begin, Iterator end, MapFunctor function) 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 @@ -245,7 +311,7 @@ */ /*! - \fn QFuture QtConcurrent::mapped(const Sequence &sequence, MapFunction function) + \fn template QFuture::ResultType> QtConcurrent::mapped(const Sequence &sequence, MapFunctor function) 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 @@ -255,7 +321,7 @@ */ /*! - \fn QFuture QtConcurrent::mapped(ConstIterator begin, ConstIterator end, MapFunction function) + \fn template QFuture::ResultType> QtConcurrent::mapped(Iterator begin, Iterator end, MapFunctor function) 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 @@ -265,9 +331,7 @@ */ /*! - \fn QFuture QtConcurrent::mappedReduced(const Sequence &sequence, - MapFunction mapFunction, ReduceFunction reduceFunction, - QtConcurrent::ReduceOptions reduceOptions) + \fn template QFuture QtConcurrent::mappedReduced(const Sequence &sequence, MapFunctor mapFunction, ReduceFunctor reduceFunction, QtConcurrent::ReduceOptions reduceOptions) Calls \a mapFunction once for each item in \a sequence. The return value of each \a mapFunction is passed to \a reduceFunction. @@ -280,9 +344,7 @@ */ /*! - \fn QFuture QtConcurrent::mappedReduced(ConstIterator begin, - ConstIterator end, MapFunction mapFunction, ReduceFunction reduceFunction, - QtConcurrent::ReduceOptions reduceOptions) + \fn template QFuture QtConcurrent::mappedReduced(Iterator begin, Iterator end, MapFunctor mapFunction, ReduceFunctor reduceFunction, QtConcurrent::ReduceOptions reduceOptions) 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. @@ -297,7 +359,7 @@ */ /*! - \fn void QtConcurrent::blockingMap(Sequence &sequence, MapFunction function) + \fn template void QtConcurrent::blockingMap(Sequence &sequence, MapFunctor function) 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 @@ -309,7 +371,7 @@ */ /*! - \fn void QtConcurrent::blockingMap(Iterator begin, Iterator end, MapFunction function) + \fn template void QtConcurrent::blockingMap(Iterator begin, Iterator end, MapFunctor function) 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 @@ -322,7 +384,7 @@ */ /*! - \fn T QtConcurrent::blockingMapped(const Sequence &sequence, MapFunction function) + \fn template OutputSequence QtConcurrent::blockingMapped(const InputSequence &sequence, MapFunctor function) Calls \a function once for each item in \a sequence and returns a Sequence containing the results. The type of the results will match the type returned my the MapFunction. @@ -333,7 +395,7 @@ */ /*! - \fn T QtConcurrent::blockingMapped(ConstIterator begin, ConstIterator end, MapFunction function) + \fn template Sequence QtConcurrent::blockingMapped(Iterator begin, Iterator end, MapFunctor function) Calls \a function once for each item from \a begin to \a end and returns a container with the results. Specify the type of container as the a template @@ -350,7 +412,7 @@ */ /*! - \fn T QtConcurrent::blockingMappedReduced(const Sequence &sequence, MapFunction mapFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions) + \fn template ResultType QtConcurrent::blockingMappedReduced(const Sequence &sequence, MapFunctor mapFunction, ReduceFunctor reduceFunction, QtConcurrent::ReduceOptions reduceOptions) Calls \a mapFunction once for each item in \a sequence. The return value of each \a mapFunction is passed to \a reduceFunction. @@ -365,7 +427,7 @@ */ /*! - \fn T QtConcurrent::blockingMappedReduced(ConstIterator begin, ConstIterator end, MapFunction mapFunction, ReduceFunction reduceFunction, QtConcurrent::ReduceOptions reduceOptions) + \fn template ResultType QtConcurrent::blockingMappedReduced(Iterator begin, Iterator end, MapFunctor mapFunction, ReduceFunctor reduceFunction, QtConcurrent::ReduceOptions reduceOptions) 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. -- cgit v1.2.3