summaryrefslogtreecommitdiffstats
path: root/src/corelib/kernel/qabstracteventdispatcher.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/kernel/qabstracteventdispatcher.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/kernel/qabstracteventdispatcher.cpp')
-rw-r--r--src/corelib/kernel/qabstracteventdispatcher.cpp18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/corelib/kernel/qabstracteventdispatcher.cpp b/src/corelib/kernel/qabstracteventdispatcher.cpp
index 6558893036..54524fa55b 100644
--- a/src/corelib/kernel/qabstracteventdispatcher.cpp
+++ b/src/corelib/kernel/qabstracteventdispatcher.cpp
@@ -179,8 +179,8 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread)
\fn bool QAbstractEventDispatcher::processEvents(QEventLoop::ProcessEventsFlags flags)
Processes pending events that match \a flags until there are no
- more events to process. Returns true if an event was processed;
- otherwise returns false.
+ more events to process. Returns \c true if an event was processed;
+ otherwise returns \c false.
This function is especially useful if you have a long running
operation and want to show its progress without allowing user
@@ -211,7 +211,7 @@ QAbstractEventDispatcher *QAbstractEventDispatcher::instance(QThread *thread)
/*! \fn bool QAbstractEventDispatcher::hasPendingEvents()
- Returns true if there is an event waiting; otherwise returns
+ Returns \c true if there is an event waiting; otherwise returns
false.
*/
@@ -271,7 +271,7 @@ int QAbstractEventDispatcher::registerTimer(int interval, Qt::TimerType timerTyp
\fn bool QAbstractEventDispatcher::unregisterTimer(int timerId)
Unregisters the timer with the given \a timerId.
- Returns true if successful; otherwise returns false.
+ Returns \c true if successful; otherwise returns \c false.
\sa registerTimer(), unregisterTimers()
*/
@@ -280,7 +280,7 @@ int QAbstractEventDispatcher::registerTimer(int interval, Qt::TimerType timerTyp
\fn bool QAbstractEventDispatcher::unregisterTimers(QObject *object)
Unregisters all the timers associated with the given \a object.
- Returns true if all timers were successful removed; otherwise returns false.
+ Returns \c true if all timers were successful removed; otherwise returns \c false.
\sa unregisterTimer(), registeredTimers()
*/
@@ -435,8 +435,8 @@ void QAbstractEventDispatcher::removeNativeEventFilter(QAbstractNativeEventFilte
/*!
Sends \a message through the event filters that were set by
- installNativeEventFilter(). This function returns true as soon as an
- event filter returns true, and false otherwise to indicate that
+ installNativeEventFilter(). This function returns \c true as soon as an
+ event filter returns \c true, and false otherwise to indicate that
the processing of the event should continue.
Subclasses of QAbstractEventDispatcher \e must call this function
@@ -474,8 +474,8 @@ bool QAbstractEventDispatcher::filterNativeEvent(const QByteArray &eventType, vo
\deprecated
Calls filterNativeEvent() with an empty eventType and \a message.
- This function returns true as soon as an
- event filter returns true, and false otherwise to indicate that
+ This function returns \c true as soon as an
+ event filter returns \c true, and false otherwise to indicate that
the processing of the event should continue.
*/