From 4533cc994484a2308297e64e99af005fb4dca065 Mon Sep 17 00:00:00 2001 From: Jerome Pasion Date: Wed, 2 Oct 2013 16:51:05 +0200 Subject: 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 Reviewed-by: Jerome Pasion --- src/dbus/qdbusabstractinterface.cpp | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'src/dbus/qdbusabstractinterface.cpp') diff --git a/src/dbus/qdbusabstractinterface.cpp b/src/dbus/qdbusabstractinterface.cpp index 0b584963ee..bf92ccb30f 100644 --- a/src/dbus/qdbusabstractinterface.cpp +++ b/src/dbus/qdbusabstractinterface.cpp @@ -333,7 +333,7 @@ QDBusAbstractInterface::~QDBusAbstractInterface() } /*! - Returns true if this is a valid reference to a remote object. It returns false if + Returns \c true if this is a valid reference to a remote object. It returns \c false if there was an error during the creation of this interface (for instance, if the remote application does not exist). @@ -517,10 +517,10 @@ QDBusPendingCall QDBusAbstractInterface::asyncCallWithArgumentList(const QString object \a receiver. If an error occurs, the \a errorMethod on object \a receiver is called instead. - This function returns true if the queueing succeeds. It does + This function returns \c true if the queueing succeeds. It does not indicate that the executed call succeeded. If it fails, the \a errorMethod is called. If the queueing failed, this - function returns false and no slot will be called. + function returns \c false and no slot will be called. The \a returnMethod must have as its parameters the types returned by the function call. Optionally, it may have a QDBusMessage @@ -567,7 +567,7 @@ bool QDBusAbstractInterface::callWithCallback(const QString &method, the remote function or any errors emitted by it are delivered to the \a slot slot on object \a receiver. - This function returns true if the queueing succeeded: it does + This function returns \c true if the queueing succeeded: it does not indicate that the call succeeded. If it failed, the slot will be called with an error message. lastError() will not be set under those circumstances. -- cgit v1.2.3