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/statemachine | |
| 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/statemachine')
| -rw-r--r-- | src/corelib/statemachine/qsignaltransition.cpp | 4 | ||||
| -rw-r--r-- | src/corelib/statemachine/qstatemachine.cpp | 10 |
2 files changed, 7 insertions, 7 deletions
diff --git a/src/corelib/statemachine/qsignaltransition.cpp b/src/corelib/statemachine/qsignaltransition.cpp index 9da075bc7f..f1f4786bcc 100644 --- a/src/corelib/statemachine/qsignaltransition.cpp +++ b/src/corelib/statemachine/qsignaltransition.cpp @@ -212,9 +212,9 @@ void QSignalTransition::setSignal(const QByteArray &signal) /*! \reimp - The default implementation returns true if the \a event is a + The default implementation returns \c true if the \a event is a QStateMachine::SignalEvent object and the event's sender and signal index - match this transition, and returns false otherwise. + match this transition, and returns \c false otherwise. */ bool QSignalTransition::eventTest(QEvent *event) { diff --git a/src/corelib/statemachine/qstatemachine.cpp b/src/corelib/statemachine/qstatemachine.cpp index 883d62113c..4dba12e1b0 100644 --- a/src/corelib/statemachine/qstatemachine.cpp +++ b/src/corelib/statemachine/qstatemachine.cpp @@ -169,7 +169,7 @@ QT_BEGIN_NAMESPACE \brief whether animations are enabled - The default value of this property is true. + The default value of this property is \c true. \sa QAbstractTransition::addAnimation() */ @@ -862,8 +862,8 @@ bool QStateMachinePrivate::isInFinalState(QAbstractState* s) const /*! \internal - Returns true if the given state has saved the value of the given property, - otherwise returns false. + Returns \c true if the given state has saved the value of the given property, + otherwise returns \c false. */ bool QStateMachinePrivate::hasRestorable(QAbstractState *state, QObject *object, const QByteArray &propertyName) const @@ -2264,8 +2264,8 @@ int QStateMachine::postDelayedEvent(QEvent *event, int delay) \threadsafe Cancels the delayed event identified by the given \a id. The id should be a - value returned by a call to postDelayedEvent(). Returns true if the event - was successfully cancelled, otherwise returns false. + value returned by a call to postDelayedEvent(). Returns \c true if the event + was successfully cancelled, otherwise returns \c false. \sa postDelayedEvent() */ |