summaryrefslogtreecommitdiffstats
path: root/src/corelib/thread/qthreadpool.cpp
diff options
context:
space:
mode:
authorJerome Pasion <jerome.pasion@digia.com>2013-10-02 16:51:05 +0200
committerThe Qt Project <gerrit-noreply@qt-project.org>2013-10-08 00:46:27 +0200
commit4533cc994484a2308297e64e99af005fb4dca065 (patch)
treebc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/thread/qthreadpool.cpp
parent50dd0232b61d8ea3fb9aab18972c6e19678656e6 (diff)
Doc: Adding mark-up to boolean default values.
Default values should have mark-up to denote that they are code. This commit changes: -"property is true" to "property is \c true". -"Returns true" to "Returns \c true". -"property is false" to "property is \c false". -"returns true" to "returns \c true". -"returns false" to "returns \c false". src/3rdparty and non-documentation instances were ignored. Task-number: QTBUG-33360 Change-Id: Ie87eaa57af947caa1230602b61c5c46292a4cf4e Reviewed-by: Oswald Buddenhagen <oswald.buddenhagen@digia.com> Reviewed-by: Jerome Pasion <jerome.pasion@digia.com>
Diffstat (limited to 'src/corelib/thread/qthreadpool.cpp')
-rw-r--r--src/corelib/thread/qthreadpool.cpp18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/corelib/thread/qthreadpool.cpp b/src/corelib/thread/qthreadpool.cpp
index 9ef40a5209..fb1d1ee7cc 100644
--- a/src/corelib/thread/qthreadpool.cpp
+++ b/src/corelib/thread/qthreadpool.cpp
@@ -441,10 +441,10 @@ QThreadPool *QThreadPool::globalInstance()
be used to control the run queue's order of execution.
Note that the thread pool takes ownership of the \a runnable if
- \l{QRunnable::autoDelete()}{runnable->autoDelete()} returns true,
+ \l{QRunnable::autoDelete()}{runnable->autoDelete()} returns \c true,
and the \a runnable will be deleted automatically by the thread
pool after the \l{QRunnable::run()}{runnable->run()} returns. If
- \l{QRunnable::autoDelete()}{runnable->autoDelete()} returns false,
+ \l{QRunnable::autoDelete()}{runnable->autoDelete()} returns \c false,
ownership of \a runnable remains with the caller. Note that
changing the auto-deletion on \a runnable after calling this
functions results in undefined behavior.
@@ -470,14 +470,14 @@ void QThreadPool::start(QRunnable *runnable, int priority)
Attempts to reserve a thread to run \a runnable.
If no threads are available at the time of calling, then this function
- does nothing and returns false. Otherwise, \a runnable is run immediately
- using one available thread and this function returns true.
+ does nothing and returns \c false. Otherwise, \a runnable is run immediately
+ using one available thread and this function returns \c true.
Note that the thread pool takes ownership of the \a runnable if
- \l{QRunnable::autoDelete()}{runnable->autoDelete()} returns true,
+ \l{QRunnable::autoDelete()}{runnable->autoDelete()} returns \c true,
and the \a runnable will be deleted automatically by the thread
pool after the \l{QRunnable::run()}{runnable->run()} returns. If
- \l{QRunnable::autoDelete()}{runnable->autoDelete()} returns false,
+ \l{QRunnable::autoDelete()}{runnable->autoDelete()} returns \c false,
ownership of \a runnable remains with the caller. Note that
changing the auto-deletion on \a runnable after calling this
function results in undefined behavior.
@@ -612,8 +612,8 @@ void QThreadPool::releaseThread()
/*!
Waits up to \a msecs milliseconds for all threads to exit and removes all
- threads from the thread pool. Returns true if all threads were removed;
- otherwise it returns false. If \a msecs is -1 (the default), the timeout
+ threads from the thread pool. Returns \c true if all threads were removed;
+ otherwise it returns \c false. If \a msecs is -1 (the default), the timeout
is ignored (waits for the last thread to exit).
*/
bool QThreadPool::waitForDone(int msecs)
@@ -630,7 +630,7 @@ bool QThreadPool::waitForDone(int msecs)
Removes the runnables that are not yet started from the queue.
The runnables for which \l{QRunnable::autoDelete()}{runnable->autoDelete()}
- returns true are deleted.
+ returns \c true are deleted.
\sa start()
*/