summaryrefslogtreecommitdiffstats
path: root/src/corelib/concurrent
diff options
context:
space:
mode:
Diffstat (limited to 'src/corelib/concurrent')
-rw-r--r--src/corelib/concurrent/qfuture.cpp6
-rw-r--r--src/corelib/concurrent/qfuturesynchronizer.cpp6
-rw-r--r--src/corelib/concurrent/qfuturewatcher.cpp4
-rw-r--r--src/corelib/concurrent/qrunnable.cpp2
-rw-r--r--src/corelib/concurrent/qtconcurrentfilter.cpp4
-rw-r--r--src/corelib/concurrent/qtconcurrentmap.cpp10
-rw-r--r--src/corelib/concurrent/qtconcurrentrun.cpp6
-rw-r--r--src/corelib/concurrent/qthreadpool.cpp4
8 files changed, 27 insertions, 15 deletions
diff --git a/src/corelib/concurrent/qfuture.cpp b/src/corelib/concurrent/qfuture.cpp
index a366a4b..f0c1e34 100644
--- a/src/corelib/concurrent/qfuture.cpp
+++ b/src/corelib/concurrent/qfuture.cpp
@@ -44,8 +44,10 @@
\brief The QFuture class represents the result of an asynchronous computation.
\since 4.4
+ \ingroup thread
+
To start a computation, use one of the APIs in the
- \l {threads.html#qtconcurrent-intro}{Qt Concurrent} framework.
+ \l {Concurrent Programming}{Qt Concurrent} framework.
QFuture allows threads to be synchronized against one or more results
which will be ready at a later point in time. The result can be of any type
@@ -90,7 +92,7 @@
To interact with running tasks using signals and slots, use QFutureWatcher.
- \sa QFutureWatcher, {threads.html#qtconcurrent-intro}{Qt Concurrent}
+ \sa QFutureWatcher, {Concurrent Programming}{Qt Concurrent}
*/
/*! \fn QFuture::QFuture()
diff --git a/src/corelib/concurrent/qfuturesynchronizer.cpp b/src/corelib/concurrent/qfuturesynchronizer.cpp
index 1fd7198..dfb693e 100644
--- a/src/corelib/concurrent/qfuturesynchronizer.cpp
+++ b/src/corelib/concurrent/qfuturesynchronizer.cpp
@@ -44,7 +44,9 @@
\brief The QFutureSynchronizer class is a convenience class that simplifies
QFuture synchronization.
-
+
+ \ingroup thread
+
QFutureSynchronizer is a template class that simplifies synchronization of
one or more QFuture objects. Futures are added using the addFuture() or
setFuture() functions. The futures() function returns a list of futures.
@@ -63,7 +65,7 @@
You can query the status of the cancel-on-wait feature using the
cancelOnWait() function.
- \sa QFuture, QFutureWatcher, {threads.html#qtconcurrent-intro}{Qt Concurrent}
+ \sa QFuture, QFutureWatcher, {Concurrent Programming}{Qt Concurrent}
*/
/*!
diff --git a/src/corelib/concurrent/qfuturewatcher.cpp b/src/corelib/concurrent/qfuturewatcher.cpp
index f0f06f9..4e9e723 100644
--- a/src/corelib/concurrent/qfuturewatcher.cpp
+++ b/src/corelib/concurrent/qfuturewatcher.cpp
@@ -55,6 +55,8 @@ QT_BEGIN_NAMESPACE
\reentrant
\since 4.4
+ \ingroup thread
+
\brief The QFutureWatcher class allows monitoring a QFuture using signals
and slots.
@@ -94,7 +96,7 @@ QT_BEGIN_NAMESPACE
QFutureWatcher<void> as well. This is useful if only status or progress
information is needed; not the actual result data.
- \sa QFuture, {threads.html#qtconcurrent-intro}{Qt Concurrent}
+ \sa QFuture, {Concurrent Programming}{Qt Concurrent}
*/
/*! \fn QFutureWatcher::QFutureWatcher(QObject *parent)
diff --git a/src/corelib/concurrent/qrunnable.cpp b/src/corelib/concurrent/qrunnable.cpp
index 86a099b..db33803 100644
--- a/src/corelib/concurrent/qrunnable.cpp
+++ b/src/corelib/concurrent/qrunnable.cpp
@@ -44,6 +44,8 @@
\since 4.4
\brief The QRunnable class is the base class for all runnable objects.
+ \ingroup thread
+
The QRunnable class is an interface for representing a task or
piece of code that needs to be executed, represented by your
reimplementation of the run() function.
diff --git a/src/corelib/concurrent/qtconcurrentfilter.cpp b/src/corelib/concurrent/qtconcurrentfilter.cpp
index f4572b8..4ab0723 100644
--- a/src/corelib/concurrent/qtconcurrentfilter.cpp
+++ b/src/corelib/concurrent/qtconcurrentfilter.cpp
@@ -42,12 +42,12 @@
/*!
\headerfile <QtConcurrentFilter>
\title Concurrent Filter and Filter-Reduce
- \ingroup threading
+ \ingroup thread
\brief The <QtConcurrentFilter> header provides concurrent Filter and
Filter-Reduce.
- These functions are a part of the \l {threads.html#qtconcurrent-intro}{Qt Concurrent} framework.
+ These functions are a part of the \l {Concurrent Programming}{Qt Concurrent} framework.
The QtConcurrent::filter(), QtConcurrent::filtered() and
QtConcurrent::filteredReduced() functions filter items in a sequence such
diff --git a/src/corelib/concurrent/qtconcurrentmap.cpp b/src/corelib/concurrent/qtconcurrentmap.cpp
index 80baa8f..3fd044d 100644
--- a/src/corelib/concurrent/qtconcurrentmap.cpp
+++ b/src/corelib/concurrent/qtconcurrentmap.cpp
@@ -47,7 +47,9 @@
possible to write multi-threaded programs without using low-level
threading primitives.
- See the \l {threads.html#qtconcurrent-intro}{Qt Concurrent} section in the \l{threads.html}{threading} documentation.
+ See the \l {Concurrent Programming}{Qt Concurrent} chapter in
+ the \l{threads.html}{threading} documentation.
+
\inheaderfile QtCore
\ingroup thread
*/
@@ -58,8 +60,6 @@
\brief The QtConcurrent::internal namespace contains QtConcurrent
implementation details.
-
- \ingroup thread
*/
/*!
@@ -78,11 +78,11 @@
/*!
\headerfile <QtConcurrentMap>
\title Concurrent Map and Map-Reduce
- \ingroup threading
+ \ingroup thread
\brief The <QtConcurrentMap> header provides concurrent Map and MapReduce.
- These functions are a part of the \l {threads.html#qtconcurrent-intro}{Qt Concurrent} framework.
+ These functions are a part of the \l {Concurrent Programming}{Qt Concurrent} framework.
The QtConcurrent::map(), QtConcurrent::mapped() and
QtConcurrent::mappedReduced() functions run computations in parallel on
diff --git a/src/corelib/concurrent/qtconcurrentrun.cpp b/src/corelib/concurrent/qtconcurrentrun.cpp
index 5803abb..989f54d 100644
--- a/src/corelib/concurrent/qtconcurrentrun.cpp
+++ b/src/corelib/concurrent/qtconcurrentrun.cpp
@@ -42,11 +42,13 @@
/*!
\headerfile <QtConcurrentRun>
\title Asynchronous Run
-
+
\brief The <QtConcurrentRun> header provides a way to run a function in a
separate thread.
+
+ \ingroup thread
- This function is a part of the \l {threads.html#qtconcurrent-intro}{Qt Concurrent} framework.
+ This function is a part of the \l {Concurrent Programming}{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.
diff --git a/src/corelib/concurrent/qthreadpool.cpp b/src/corelib/concurrent/qthreadpool.cpp
index 2dfac31..9b2ac46 100644
--- a/src/corelib/concurrent/qthreadpool.cpp
+++ b/src/corelib/concurrent/qthreadpool.cpp
@@ -364,6 +364,8 @@ void QThreadPoolPrivate::stealRunnable(QRunnable *runnable)
\since 4.4
\threadsafe
+ \ingroup thread
+
QThreadPool manages and recyles individual QThread objects to help reduce
thread creation costs in programs that use threads. Each Qt application
has one global QThreadPool object, which can be accessed by calling
@@ -404,7 +406,7 @@ void QThreadPoolPrivate::stealRunnable(QRunnable *runnable)
Note that QThreadPool is a low-level class for managing threads, see
QtConcurrent::run() or the other
- \l {threads.html#qtconcurrent-intro}{Qt Concurrent} APIs for higher
+ \l {Concurrent Programming}{Qt Concurrent} APIs for higher
level alternatives.
\sa QRunnable