summaryrefslogtreecommitdiffstats
path: root/src/corelib/thread
diff options
context:
space:
mode:
authorOlivier Goffart <ogoffart@woboq.com>2012-10-10 17:28:42 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2012-10-15 10:18:31 +0200
commit3356a331f699c62a6e22243a6f7cc693c3480fde (patch)
treea9e4ea4b381256c4bd8580169488624024366e81 /src/corelib/thread
parentf8cfb4bebd331ca950511570d141c5ec9172c7e6 (diff)
QThread signals documentation improvement
Be more explicit on from which thread the signals are emitted, and mention that it is possible to connect finished with deleteLater Change-Id: Ib72be94a81be383774f08d71915fa609843030e0 Reviewed-by: Marc Mutz <marc.mutz@kdab.com> Reviewed-by: Eskil Abrahamsen Blomfeldt <eskil.abrahamsen-blomfeldt@digia.com>
Diffstat (limited to 'src/corelib/thread')
-rw-r--r--src/corelib/thread/qthread.cpp14
1 files changed, 12 insertions, 2 deletions
diff --git a/src/corelib/thread/qthread.cpp b/src/corelib/thread/qthread.cpp
index 5949f9aefe..72bae48eba 100644
--- a/src/corelib/thread/qthread.cpp
+++ b/src/corelib/thread/qthread.cpp
@@ -323,7 +323,8 @@ QThreadPrivate::~QThreadPrivate()
/*!
\fn void QThread::started()
- This signal is emitted when the thread starts executing.
+ This signal is emitted from the associated thread when it starts executing,
+ before the run() function is called.
\sa finished(), terminated()
*/
@@ -331,7 +332,14 @@ QThreadPrivate::~QThreadPrivate()
/*!
\fn void QThread::finished()
- This signal is emitted when the thread has finished executing.
+ This signal is emitted from the associated thread right before it finishes executing.
+
+ When this signal is emitted, the event loop has already stopped running.
+ No more events will be processed in the thread, except for deferred deletion events.
+ This signal can be connected to QObject::deleteLater(), to free objects in that thread.
+
+ \note If the associated thread was terminated using terminate(), it is undefined from
+ which thread this signal is emitted.
\sa started(), terminated()
*/
@@ -341,6 +349,8 @@ QThreadPrivate::~QThreadPrivate()
This signal is emitted when the thread is terminated.
+ It is undefined from which thread this signal is emitted.
+
\sa started(), finished()
*/