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/dbus/qdbuspendingcall.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/dbus/qdbuspendingcall.cpp')
| -rw-r--r-- | src/dbus/qdbuspendingcall.cpp | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/dbus/qdbuspendingcall.cpp b/src/dbus/qdbuspendingcall.cpp index e990e7d18b..de758b515b 100644 --- a/src/dbus/qdbuspendingcall.cpp +++ b/src/dbus/qdbuspendingcall.cpp @@ -302,7 +302,7 @@ QDBusPendingCall &QDBusPendingCall::operator=(const QDBusPendingCall &other) /*! \fn bool QDBusPendingCallWatcher::isFinished() const - Returns true if the pending call has finished processing and the + Returns \c true if the pending call has finished processing and the reply has been received. Note that this function only changes state if you call @@ -314,8 +314,8 @@ QDBusPendingCall &QDBusPendingCall::operator=(const QDBusPendingCall &other) /*! \fn bool QDBusPendingReply::isFinished() const - Returns true if the pending call has finished processing and the - reply has been received. If this function returns true, the + Returns \c true if the pending call has finished processing and the + reply has been received. If this function returns \c true, the isError(), error() and reply() methods should return valid information. @@ -343,7 +343,7 @@ void QDBusPendingCall::waitForFinished() /*! \fn bool QDBusPendingReply::isValid() const - Returns true if the reply contains a normal reply message, false + Returns \c true if the reply contains a normal reply message, false if it contains anything else. If the pending call has not finished processing, this function @@ -360,11 +360,11 @@ bool QDBusPendingCall::isValid() const /*! \fn bool QDBusPendingReply::isError() const - Returns true if the reply contains an error message, false if it + Returns \c true if the reply contains an error message, false if it contains a normal method reply. If the pending call has not finished processing, this function - also returns true. + also returns \c true. */ bool QDBusPendingCall::isError() const { @@ -425,7 +425,7 @@ QDBusMessage QDBusPendingCall::reply() const The callback will not be called if the reply is an error message. - This function returns true if it could set the callback, false + This function returns \c true if it could set the callback, false otherwise. It is not a guarantee that the callback will be called. |