Fix up the QEventLoopLocker documentation.

Change-Id: If5bf8c2703f094023a614b3efcbd8489560694d9
Reviewed-by: Richard J. Moore <rich@kde.org>

1 files changed, 10 insertions, 3 deletions

diff --git a/src/corelib/kernel/qeventloop.cpp b/src/corelib/kernel/qeventloop.cpp
index 58e2c5cd2f..d3a64aae04 100644
--- a/src/corelib/kernel/qeventloop.cpp
+++ b/src/corelib/kernel/qeventloop.cpp
@@ -374,7 +374,7 @@ private:
     \brief The QEventLoopLocker class provides a means to quit an event loop when it is no longer needed.
 
     The QEventLoopLocker operates on particular objects - either a QCoreApplication
-    instance or a QEventLoop instance.
+    instance, a QEventLoop instance or a QThread instance.
 
     This makes it possible to, for example, run a batch of jobs with an event loop
     and exit that event loop after the last job is finished. That is accomplished
@@ -388,7 +388,7 @@ private:
 */
 
 /*!
-    Creates an event locker operating on the \p app.
+    Creates an event locker operating on the QCoreApplication.
 
     The application will quit when there are no more QEventLoopLockers operating on it.
 
@@ -401,7 +401,7 @@ QEventLoopLocker::QEventLoopLocker()
 }
 
 /*!
-    Creates an event locker operating on the \p app.
+    Creates an event locker operating on the \p loop.
 
     This particular QEventLoop will quit when there are no more QEventLoopLockers operating on it.
 
@@ -413,6 +413,13 @@ QEventLoopLocker::QEventLoopLocker(QEventLoop *loop)
 
 }
 
+/*!
+    Creates an event locker operating on the \p thread.
+
+    This particular QThread will quit when there are no more QEventLoopLockers operating on it.
+
+    \sa QThread::quit()
+ */
 QEventLoopLocker::QEventLoopLocker(QThread *thread)
   : d_ptr(new QEventLoopLockerPrivate(static_cast<QThreadPrivate*>(QObjectPrivate::get(thread))))
 {