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>

15 files changed, 56 insertions, 56 deletions

diff --git a/src/dbus/qdbusabstractadaptor.cpp b/src/dbus/qdbusabstractadaptor.cpp
index 5ab478e1bd..7fba3bf53a 100644
--- a/src/dbus/qdbusabstractadaptor.cpp
+++ b/src/dbus/qdbusabstractadaptor.cpp
@@ -195,8 +195,8 @@ void QDBusAbstractAdaptor::setAutoRelaySignals(bool enable)
 }
 
 /*!
-    Returns true if automatic signal relaying from the real object (see object()) is enabled,
-    otherwiser returns false.
+    Returns \c true if automatic signal relaying from the real object (see object()) is enabled,
+    otherwiser returns \c false.
 
     \sa setAutoRelaySignals()
 */
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.
diff --git a/src/dbus/qdbusargument.cpp b/src/dbus/qdbusargument.cpp
index dab2daf90f..83a544c4e3 100644
--- a/src/dbus/qdbusargument.cpp
+++ b/src/dbus/qdbusargument.cpp
@@ -1067,7 +1067,7 @@ void QDBusArgument::endMapEntry() const
 }
 
 /*!
-    Returns true if there are no more elements to be extracted from
+    Returns \c true if there are no more elements to be extracted from
     this QDBusArgument. This function is usually used in QDBusArgument
     objects returned from beginMap() and beginArray().
 */
diff --git a/src/dbus/qdbusconnection.cpp b/src/dbus/qdbusconnection.cpp
index 320787c265..f3676b1013 100644
--- a/src/dbus/qdbusconnection.cpp
+++ b/src/dbus/qdbusconnection.cpp
@@ -476,7 +476,7 @@ void QDBusConnection::disconnectFromPeer(const QString &name)
     reply. This is suitable for errors, signals, and return values as
     well as calls whose return values are not necessary.
 
-    Returns true if the message was queued successfully, false otherwise.
+    Returns \c true if the message was queued successfully, false otherwise.
 */
 bool QDBusConnection::send(const QDBusMessage &message) const
 {
@@ -506,7 +506,7 @@ bool QDBusConnection::send(const QDBusMessage &message) const
     that the slot will be called exactly once with the reply, as long
     as the parameter types match and no error occurs.
 
-    Returns true if the message was sent, or false if the message could
+    Returns \c true if the message was sent, or false if the message could
     not be sent.
 */
 bool QDBusConnection::callWithCallback(const QDBusMessage &message, QObject *receiver,
@@ -537,7 +537,7 @@ bool QDBusConnection::callWithCallback(const QDBusMessage &message, QObject *rec
     This function is dangerous because it cannot report errors, including
     the expiration of the timeout.
 
-    Returns true if the message was sent, or false if the message could
+    Returns \c true if the message was sent, or false if the message could
     not be sent.
 */
 bool QDBusConnection::callWithCallback(const QDBusMessage &message, QObject *receiver,
@@ -622,7 +622,7 @@ QDBusPendingCall QDBusConnection::asyncCall(const QDBusMessage &message, int tim
     denoting a connection to any signal of the (\a interface, \a name) pair, from any remote
     application.
 
-    Returns true if the connection was successful.
+    Returns \c true if the connection was successful.
 
     \warning The signal will only be delivered to the slot if the parameters match. This verification
              can be done only when the signal is received, not at connection time.
@@ -643,7 +643,7 @@ bool QDBusConnection::connect(const QString &service, const QString &path, const
     that this signature can be delivered to the slot specified by \a
     slot and return false otherwise.
 
-    Returns true if the connection was successful.
+    Returns \c true if the connection was successful.
 
     \note This function verifies that the signal signature matches the
           slot's parameters, but it does not verify that the actual
@@ -673,7 +673,7 @@ bool QDBusConnection::connect(const QString &service, const QString &path, const
     pass a QString that is empty but not null (i.e., QString("")). A null
     QString skips matching at that position.
 
-    Returns true if the connection was successful.
+    Returns \c true if the connection was successful.
 
     \note This function verifies that the signal signature matches the
           slot's parameters, but it does not verify that the actual
@@ -717,7 +717,7 @@ bool QDBusConnection::connect(const QString &service, const QString &path, const
     and \a name parameters from the slot \a slot in object \a receiver. The
     arguments must be the same as passed to the connect() function.
 
-    Returns true if the disconnection was successful.
+    Returns \c true if the disconnection was successful.
 */
 bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString &interface,
                                  const QString &name, QObject *receiver, const char *slot)
@@ -733,7 +733,7 @@ bool QDBusConnection::disconnect(const QString &service, const QString &path, co
     object \a receiver. The arguments must be the same as passed to the
     connect() function.
 
-    Returns true if the disconnection was successful.
+    Returns \c true if the disconnection was successful.
 */
 bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString& interface,
                                  const QString &name, const QString &signature,
@@ -751,7 +751,7 @@ bool QDBusConnection::disconnect(const QString &service, const QString &path, co
     the slot \a slot in object \a receiver. The arguments must be the same as
     passed to the connect() function.
 
-    Returns true if the disconnection was successful.
+    Returns \c true if the disconnection was successful.
 */
 bool QDBusConnection::disconnect(const QString &service, const QString &path, const QString& interface,
                                  const QString &name, const QStringList &argumentMatch, const QString &signature,
@@ -769,7 +769,7 @@ bool QDBusConnection::disconnect(const QString &service, const QString &path, co
 }
 
 /*!
-    Registers the object \a object at path \a path and returns true if
+    Registers the object \a object at path \a path and returns \c true if
     the registration was successful. The \a options parameter
     specifies how much of the object \a object will be exposed through
     D-Bus.
@@ -949,7 +949,7 @@ void *QDBusConnection::internalPointer() const
 }
 
 /*!
-    Returns true if this QDBusConnection object is connected.
+    Returns \c true if this QDBusConnection object is connected.
 */
 bool QDBusConnection::isConnected() const
 {
@@ -1021,7 +1021,7 @@ QDBusConnection::ConnectionCapabilities QDBusConnection::connectionCapabilities(
 
 /*!
     Attempts to register the \a serviceName on the D-Bus server and
-    returns true if the registration succeeded. The registration will
+    returns \c true if the registration succeeded. The registration will
     fail if the name is already registered by another application.
 
     \sa unregisterService(), QDBusConnectionInterface::registerService()
@@ -1037,7 +1037,7 @@ bool QDBusConnection::registerService(const QString &serviceName)
 
 /*!
     Unregisters the service \a serviceName that was previously
-    registered with registerService() and returns true if it
+    registered with registerService() and returns \c true if it
     succeeded.
 
     \sa registerService(), QDBusConnectionInterface::unregisterService()
diff --git a/src/dbus/qdbusconnectioninterface.cpp b/src/dbus/qdbusconnectioninterface.cpp
index d6f487d802..0bc3a1ad04 100644
--- a/src/dbus/qdbusconnectioninterface.cpp
+++ b/src/dbus/qdbusconnectioninterface.cpp
@@ -201,7 +201,7 @@ QDBusReply<QStringList> QDBusConnectionInterface::registeredServiceNames() const
 }
 
 /*!
-    Returns true if the service name \a serviceName has is currently
+    Returns \c true if the service name \a serviceName has is currently
     registered.
 */
 QDBusReply<bool> QDBusConnectionInterface::isServiceRegistered(const QString &serviceName) const
diff --git a/src/dbus/qdbuscontext.cpp b/src/dbus/qdbuscontext.cpp
index 7cc3648cf8..9cc56570e7 100644
--- a/src/dbus/qdbuscontext.cpp
+++ b/src/dbus/qdbuscontext.cpp
@@ -118,11 +118,11 @@ QDBusContext::~QDBusContext()
 }
 
 /*!
-    Returns true if we are processing a D-Bus call. If this function
-    returns true, the rest of the functions in this class are
+    Returns \c true if we are processing a D-Bus call. If this function
+    returns \c true, the rest of the functions in this class are
     available.
 
-    Accessing those functions when this function returns false is
+    Accessing those functions when this function returns \c false is
     undefined and may lead to crashes.
 */
 bool QDBusContext::calledFromDBus() const
@@ -147,7 +147,7 @@ const QDBusMessage &QDBusContext::message() const
 }
 
 /*!
-    Returns true if this call will have a delayed reply.
+    Returns \c true if this call will have a delayed reply.
 
     \sa setDelayedReply()
 */
diff --git a/src/dbus/qdbuserror.cpp b/src/dbus/qdbuserror.cpp
index ddc2be7c38..14f9491b43 100644
--- a/src/dbus/qdbuserror.cpp
+++ b/src/dbus/qdbuserror.cpp
@@ -382,7 +382,7 @@ QString QDBusError::message() const
 }
 
 /*!
-    Returns true if this is a valid error condition (i.e., if there was an error),
+    Returns \c true if this is a valid error condition (i.e., if there was an error),
     otherwise false.
 */
 
diff --git a/src/dbus/qdbusmessage.cpp b/src/dbus/qdbusmessage.cpp
index ce5af42e74..ea18de141d 100644
--- a/src/dbus/qdbusmessage.cpp
+++ b/src/dbus/qdbusmessage.cpp
@@ -744,8 +744,8 @@ QDBusMessage::MessageType QDBusMessage::type() const
     for errors, signals, and return values as well as calls whose
     return values are not necessary.
 
-    Returns true if the message was queued successfully;
-    otherwise returns false.
+    Returns \c true if the message was queued successfully;
+    otherwise returns \c false.
 
     \sa QDBusConnection::send()
 */
diff --git a/src/dbus/qdbusmetatype.cpp b/src/dbus/qdbusmetatype.cpp
index 804e80699a..b72d4c074d 100644
--- a/src/dbus/qdbusmetatype.cpp
+++ b/src/dbus/qdbusmetatype.cpp
@@ -226,7 +226,7 @@ void QDBusMetaType::registerMarshallOperators(int id, MarshallFunction mf,
 /*!
     \internal
     Executes the marshalling of type \a id (whose data is contained in
-    \a data) to the D-Bus marshalling argument \a arg. Returns true if
+    \a data) to the D-Bus marshalling argument \a arg. Returns \c true if
     the marshalling succeeded, or false if an error occurred.
 */
 bool QDBusMetaType::marshall(QDBusArgument &arg, int id, const void *data)
@@ -255,7 +255,7 @@ bool QDBusMetaType::marshall(QDBusArgument &arg, int id, const void *data)
 /*!
     \internal
     Executes the demarshalling of type \a id (whose data will be placed in
-    \a data) from the D-Bus marshalling argument \a arg. Returns true if
+    \a data) from the D-Bus marshalling argument \a arg. Returns \c true if
     the demarshalling succeeded, or false if an error occurred.
 */
 bool QDBusMetaType::demarshall(const QDBusArgument &arg, int id, void *data)
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.
 
diff --git a/src/dbus/qdbusreply.cpp b/src/dbus/qdbusreply.cpp
index 650c523720..b1326c11f1 100644
--- a/src/dbus/qdbusreply.cpp
+++ b/src/dbus/qdbusreply.cpp
@@ -149,7 +149,7 @@ QT_BEGIN_NAMESPACE
 /*!
     \fn bool QDBusReply::isValid() const
 
-    Returns true if no error occurred; otherwise, returns false.
+    Returns \c true if no error occurred; otherwise, returns \c false.
 
     \sa error()
 */
diff --git a/src/dbus/qdbusserver.cpp b/src/dbus/qdbusserver.cpp
index ae44d44045..170e6ff5cf 100644
--- a/src/dbus/qdbusserver.cpp
+++ b/src/dbus/qdbusserver.cpp
@@ -115,7 +115,7 @@ QDBusServer::~QDBusServer()
 }
 
 /*!
-    Returns true if this QDBusServer object is connected.
+    Returns \c true if this QDBusServer object is connected.
 
     If it isn't connected, you need to call the constructor again.
 */
diff --git a/src/dbus/qdbusservicewatcher.cpp b/src/dbus/qdbusservicewatcher.cpp
index f99ee599c1..7a96665abe 100644
--- a/src/dbus/qdbusservicewatcher.cpp
+++ b/src/dbus/qdbusservicewatcher.cpp
@@ -322,7 +322,7 @@ void QDBusServiceWatcher::addWatchedService(const QString &newService)
     still be signals pending delivery about \a service. Those signals will
     still be emitted whenever the D-Bus messages are processed.
 
-    This function returns true if any services were removed.
+    This function returns \c true if any services were removed.
 */
 bool QDBusServiceWatcher::removeWatchedService(const QString &service)
 {
diff --git a/src/dbus/qdbusunixfiledescriptor.cpp b/src/dbus/qdbusunixfiledescriptor.cpp
index db893337ae..63c5b40d06 100644
--- a/src/dbus/qdbusunixfiledescriptor.cpp
+++ b/src/dbus/qdbusunixfiledescriptor.cpp
@@ -197,7 +197,7 @@ QDBusUnixFileDescriptor::~QDBusUnixFileDescriptor()
 */
 
 /*!
-    Returns true if this Unix file descriptor is valid. A valid Unix file
+    Returns \c true if this Unix file descriptor is valid. A valid Unix file
     descriptor is not -1.
 
     \sa fileDescriptor()
@@ -231,11 +231,11 @@ int QDBusUnixFileDescriptor::fileDescriptor() const
 // qdoc documentation is generated on Unix
 
 /*!
-    Returns true if Unix file descriptors are supported on this platform. In
-    other words, this function returns true if this is a Unix platform.
+    Returns \c true if Unix file descriptors are supported on this platform. In
+    other words, this function returns \c true if this is a Unix platform.
 
     Note that QDBusUnixFileDescriptor continues to operate even if this
-    function returns false. The only difference is that the
+    function returns \c false. The only difference is that the
     QDBusUnixFileDescriptor objects will always be in the isValid() == false
     state and fileDescriptor() will always return -1. The class will not
     consume any operating system resources.
diff --git a/src/dbus/qdbusutil.cpp b/src/dbus/qdbusutil.cpp
index c90490df7f..c77908ef89 100644
--- a/src/dbus/qdbusutil.cpp
+++ b/src/dbus/qdbusutil.cpp
@@ -350,7 +350,7 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidInterfaceName(const QString &ifaceName)
-        Returns true if this is \a ifaceName is a valid interface name.
+        Returns \c true if this is \a ifaceName is a valid interface name.
 
         Valid interface names must:
         \list
@@ -379,7 +379,7 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidUniqueConnectionName(const QString &connName)
-        Returns true if \a connName is a valid unique connection name.
+        Returns \c true if \a connName is a valid unique connection name.
 
         Unique connection names start with a colon (":") and are followed by a list of dot-separated
         components composed of ASCII letters, digits, the hyphen or the underscore ("_") character.
@@ -410,7 +410,7 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidBusName(const QString &busName)
-        Returns true if \a busName is a valid bus name.
+        Returns \c true if \a busName is a valid bus name.
 
         A valid bus name is either a valid unique connection name or follows the rules:
         \list
@@ -453,7 +453,7 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidMemberName(const QString &memberName)
-        Returns true if \a memberName is a valid member name. A valid member name does not exceed
+        Returns \c true if \a memberName is a valid member name. A valid member name does not exceed
         255 characters in length, is not empty, is composed only of ASCII letters, digits and
         underscores, but does not start with a digit.
     */
@@ -473,7 +473,7 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidErrorName(const QString &errorName)
-        Returns true if \a errorName is a valid error name. Valid error names are valid interface
+        Returns \c true if \a errorName is a valid error name. Valid error names are valid interface
         names and vice-versa, so this function is actually an alias for isValidInterfaceName.
     */
     bool isValidErrorName(const QString &errorName)
@@ -483,7 +483,7 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidObjectPath(const QString &path)
-        Returns true if \a path is valid object path.
+        Returns \c true if \a path is valid object path.
 
         Valid object paths follow the rules:
         \list
@@ -516,7 +516,7 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidBasicType(int type)
-        Returns true if \a c is a valid, basic D-Bus type.
+        Returns \c true if \a c is a valid, basic D-Bus type.
      */
     bool isValidBasicType(int c)
     {
@@ -525,7 +525,7 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidFixedType(int type)
-        Returns true if \a c is a valid, fixed D-Bus type.
+        Returns \c true if \a c is a valid, fixed D-Bus type.
      */
     bool isValidFixedType(int c)
     {
@@ -535,8 +535,8 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidSignature(const QString &signature)
-        Returns true if \a signature is a valid D-Bus type signature for one or more types.
-        This function returns true if it can all of \a signature into valid, individual types and no
+        Returns \c true if \a signature is a valid D-Bus type signature for one or more types.
+        This function returns \c true if it can all of \a signature into valid, individual types and no
         characters remain in \a signature.
 
         \sa isValidSingleSignature()
@@ -556,9 +556,9 @@ namespace QDBusUtil
 
     /*!
         \fn bool QDBusUtil::isValidSingleSignature(const QString &signature)
-        Returns true if \a signature is a valid D-Bus type signature for exactly one full type. This
+        Returns \c true if \a signature is a valid D-Bus type signature for exactly one full type. This
         function tries to convert the type signature into a D-Bus type and, if it succeeds and no
-        characters remain in the signature, it returns true.
+        characters remain in the signature, it returns \c true.
     */
     bool isValidSingleSignature(const QString &signature)
     {