diff options
| author | Jerome Pasion <jerome.pasion@digia.com> | 2013-10-02 16:51:05 +0200 |
|---|---|---|
| committer | The Qt Project <gerrit-noreply@qt-project.org> | 2013-10-08 00:46:27 +0200 |
| commit | 4533cc994484a2308297e64e99af005fb4dca065 (patch) | |
| tree | bc66283d11cdad100a1aec03f4e1d86bedc9a79e /src/corelib/kernel/qcoreevent.cpp | |
| parent | 50dd0232b61d8ea3fb9aab18972c6e19678656e6 (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/qcoreevent.cpp')
| -rw-r--r-- | src/corelib/kernel/qcoreevent.cpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/corelib/kernel/qcoreevent.cpp b/src/corelib/kernel/qcoreevent.cpp index 09fe7c60ca..cce385352e 100644 --- a/src/corelib/kernel/qcoreevent.cpp +++ b/src/corelib/kernel/qcoreevent.cpp @@ -61,9 +61,9 @@ QT_BEGIN_NAMESPACE QEvents, and sends the translated events to \l{QObject}s. In general, events come from the underlying window system - (spontaneous() returns true), but it is also possible to manually + (spontaneous() returns \c true), but it is also possible to manually send events using QCoreApplication::sendEvent() and - QCoreApplication::postEvent() (spontaneous() returns false). + QCoreApplication::postEvent() (spontaneous() returns \c false). QObjects receive events by having their QObject::event() function called. The function can be reimplemented in subclasses to @@ -382,8 +382,8 @@ QEvent::~QEvent() /*! \fn bool QEvent::spontaneous() const - Returns true if the event originated outside the application (a - system event); otherwise returns false. + Returns \c true if the event originated outside the application (a + system event); otherwise returns \c false. The return value of this function is not defined for paint events. */ @@ -487,7 +487,7 @@ QTimerEvent::~QTimerEvent() added or removed. In both cases you can only rely on the child being a QObject (or, - if QObject::isWidgetType() returns true, a QWidget). This is + if QObject::isWidgetType() returns \c true, a QWidget). This is because in the QEvent::ChildAdded case the child is not yet fully constructed; in the QEvent::ChildRemoved case it might have already been destructed. @@ -524,21 +524,21 @@ QChildEvent::~QChildEvent() /*! \fn bool QChildEvent::added() const - Returns true if type() is QEvent::ChildAdded; otherwise returns + Returns \c true if type() is QEvent::ChildAdded; otherwise returns false. */ /*! \fn bool QChildEvent::removed() const - Returns true if type() is QEvent::ChildRemoved; otherwise returns + Returns \c true if type() is QEvent::ChildRemoved; otherwise returns false. */ /*! \fn bool QChildEvent::polished() const - Returns true if type() is QEvent::ChildPolished; otherwise returns + Returns \c true if type() is QEvent::ChildPolished; otherwise returns false. */ |