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>

5 files changed, 46 insertions, 46 deletions

diff --git a/src/network/kernel/qauthenticator.cpp b/src/network/kernel/qauthenticator.cpp
index 0ea97f25a6..e1a24a226f 100644
--- a/src/network/kernel/qauthenticator.cpp
+++ b/src/network/kernel/qauthenticator.cpp
@@ -197,8 +197,8 @@ QAuthenticator &QAuthenticator::operator=(const QAuthenticator &other)
 }
 
 /*!
-    Returns true if this authenticator is identical to \a other; otherwise
-    returns false.
+    Returns \c true if this authenticator is identical to \a other; otherwise
+    returns \c false.
 */
 bool QAuthenticator::operator==(const QAuthenticator &other) const
 {
@@ -214,8 +214,8 @@ bool QAuthenticator::operator==(const QAuthenticator &other) const
 /*!
     \fn bool QAuthenticator::operator!=(const QAuthenticator &other) const
 
-    Returns true if this authenticator is different from \a other; otherwise
-    returns false.
+    Returns \c true if this authenticator is different from \a other; otherwise
+    returns \c false.
 */
 
 /*!
@@ -320,7 +320,7 @@ void QAuthenticator::setOption(const QString &opt, const QVariant &value)
 
 
 /*!
-    Returns true if the authenticator is null.
+    Returns \c true if the authenticator is null.
 */
 bool QAuthenticator::isNull() const
 {
diff --git a/src/network/kernel/qhostaddress.cpp b/src/network/kernel/qhostaddress.cpp
index 5ef428305c..18fd6dee58 100644
--- a/src/network/kernel/qhostaddress.cpp
+++ b/src/network/kernel/qhostaddress.cpp
@@ -530,15 +530,15 @@ QHostAddress &QHostAddress::operator=(const QString &address)
     \fn bool QHostAddress::operator!=(const QHostAddress &other) const
     \since 4.2
 
-    Returns true if this host address is not the same as the \a other
-    address given; otherwise returns false.
+    Returns \c true if this host address is not the same as the \a other
+    address given; otherwise returns \c false.
 */
 
 /*!
     \fn bool QHostAddress::operator!=(SpecialAddress other) const
 
-    Returns true if this host address is not the same as the \a other
-    address given; otherwise returns false.
+    Returns \c true if this host address is not the same as the \a other
+    address given; otherwise returns \c false.
 */
 
 /*!
@@ -585,8 +585,8 @@ void QHostAddress::setAddress(const Q_IPV6ADDR &ip6Addr)
 
     Sets the IPv4 or IPv6 address specified by the string
     representation specified by \a address (e.g. "127.0.0.1").
-    Returns true and sets the address if the address was successfully
-    parsed; otherwise returns false.
+    Returns \c true and sets the address if the address was successfully
+    parsed; otherwise returns \c false.
 */
 bool QHostAddress::setAddress(const QString &address)
 {
@@ -599,8 +599,8 @@ bool QHostAddress::setAddress(const QString &address)
     \overload
 
     Sets the IPv4 or IPv6 address specified by the native structure \a
-    sockaddr.  Returns true and sets the address if the address was
-    successfully parsed; otherwise returns false.
+    sockaddr.  Returns \c true and sets the address if the address was
+    successfully parsed; otherwise returns \c false.
 */
 void QHostAddress::setAddress(const struct sockaddr *sockaddr)
 {
@@ -754,8 +754,8 @@ void QHostAddress::setScopeId(const QString &id)
 }
 
 /*!
-    Returns true if this host address is the same as the \a other address
-    given; otherwise returns false.
+    Returns \c true if this host address is the same as the \a other address
+    given; otherwise returns \c false.
 */
 bool QHostAddress::operator==(const QHostAddress &other) const
 {
@@ -772,8 +772,8 @@ bool QHostAddress::operator==(const QHostAddress &other) const
 }
 
 /*!
-    Returns true if this host address is the same as the \a other
-    address given; otherwise returns false.
+    Returns \c true if this host address is the same as the \a other
+    address given; otherwise returns \c false.
 */
 bool QHostAddress::operator ==(SpecialAddress other) const
 {
@@ -793,7 +793,7 @@ bool QHostAddress::operator ==(SpecialAddress other) const
 }
 
 /*!
-    Returns true if this host address is null (INADDR_ANY or in6addr_any).
+    Returns \c true if this host address is null (INADDR_ANY or in6addr_any).
     The default constructor creates a null address, and that address is
     not valid for any host or interface.
 */
@@ -806,7 +806,7 @@ bool QHostAddress::isNull() const
 /*!
     \since 4.5
 
-    Returns true if this IP is in the subnet described by the network
+    Returns \c true if this IP is in the subnet described by the network
     prefix \a subnet and netmask \a netmask.
 
     An IP is considered to belong to a subnet if it is contained
@@ -866,7 +866,7 @@ bool QHostAddress::isInSubnet(const QHostAddress &subnet, int netmask) const
     \since 4.5
     \overload
 
-    Returns true if this IP is in the subnet described by \a
+    Returns \c true if this IP is in the subnet described by \a
     subnet. The QHostAddress member of \a subnet contains the network
     prefix and the int (second) member contains the netmask (prefix
     length).
@@ -1002,7 +1002,7 @@ QPair<QHostAddress, int> QHostAddress::parseSubnet(const QString &subnet)
 /*!
     \since 5.0
 
-    returns true if the address is the IPv6 loopback address, or any
+    returns \c true if the address is the IPv6 loopback address, or any
     of the IPv4 loopback addresses.
 */
 bool QHostAddress::isLoopback() const
diff --git a/src/network/kernel/qnetworkinterface.cpp b/src/network/kernel/qnetworkinterface.cpp
index f47638db86..632b0cd156 100644
--- a/src/network/kernel/qnetworkinterface.cpp
+++ b/src/network/kernel/qnetworkinterface.cpp
@@ -201,7 +201,7 @@ QNetworkAddressEntry::~QNetworkAddressEntry()
 }
 
 /*!
-    Returns true if this network address entry is the same as \a
+    Returns \c true if this network address entry is the same as \a
     other.
 */
 bool QNetworkAddressEntry::operator==(const QNetworkAddressEntry &other) const
@@ -216,7 +216,7 @@ bool QNetworkAddressEntry::operator==(const QNetworkAddressEntry &other) const
 /*!
     \fn bool QNetworkAddressEntry::operator!=(const QNetworkAddressEntry &other) const
 
-    Returns true if this network address entry is different from \a
+    Returns \c true if this network address entry is different from \a
     other.
 */
 
@@ -435,7 +435,7 @@ QNetworkInterface &QNetworkInterface::operator=(const QNetworkInterface &other)
 */
 
 /*!
-    Returns true if this QNetworkInterface object contains valid
+    Returns \c true if this QNetworkInterface object contains valid
     information about a network interface.
 */
 bool QNetworkInterface::isValid() const
diff --git a/src/network/kernel/qnetworkproxy.cpp b/src/network/kernel/qnetworkproxy.cpp
index a38655d244..5cc41392b5 100644
--- a/src/network/kernel/qnetworkproxy.cpp
+++ b/src/network/kernel/qnetworkproxy.cpp
@@ -499,7 +499,7 @@ QNetworkProxy::~QNetworkProxy()
 /*!
     \since 4.4
 
-    Compares the value of this network proxy to \a other and returns true
+    Compares the value of this network proxy to \a other and returns \c true
     if they are equal (same proxy type, server as well as username and password)
 */
 bool QNetworkProxy::operator==(const QNetworkProxy &other) const
@@ -511,7 +511,7 @@ bool QNetworkProxy::operator==(const QNetworkProxy &other) const
     \fn bool QNetworkProxy::operator!=(const QNetworkProxy &other) const
     \since 4.4
 
-    Compares the value of this network proxy to \a other and returns true
+    Compares the value of this network proxy to \a other and returns \c true
     if they differ.
 \*/
 
@@ -588,7 +588,7 @@ QNetworkProxy::Capabilities QNetworkProxy::capabilities() const
 /*!
     \since 4.4
 
-    Returns true if this proxy supports the
+    Returns \c true if this proxy supports the
     QNetworkProxy::CachingCapability capability.
 
     In Qt 4.4, the capability was tied to the proxy type, but since Qt
@@ -605,7 +605,7 @@ bool QNetworkProxy::isCachingProxy() const
 /*!
     \since 4.4
 
-    Returns true if this proxy supports transparent tunneling of TCP
+    Returns \c true if this proxy supports transparent tunneling of TCP
     connections. This matches the QNetworkProxy::TunnelingCapability
     capability.
 
@@ -775,8 +775,8 @@ void QNetworkProxy::setHeader(QNetworkRequest::KnownHeaders header, const QVaria
 
 /*!
     \since 5.0
-    Returns true if the raw header \a headerName is in use for this
-    proxy. Returns false if the proxy is not of type HttpProxy or
+    Returns \c true if the raw header \a headerName is in use for this
+    proxy. Returns \c false if the proxy is not of type HttpProxy or
     HttpCachingProxy.
 
     \sa rawHeader(), setRawHeader()
@@ -1165,7 +1165,7 @@ QNetworkProxyQuery &QNetworkProxyQuery::operator=(const QNetworkProxyQuery &othe
 */
 
 /*!
-    Returns true if this QNetworkProxyQuery object contains the same
+    Returns \c true if this QNetworkProxyQuery object contains the same
     data as \a other.
 */
 bool QNetworkProxyQuery::operator==(const QNetworkProxyQuery &other) const
@@ -1176,7 +1176,7 @@ bool QNetworkProxyQuery::operator==(const QNetworkProxyQuery &other) const
 /*!
     \fn bool QNetworkProxyQuery::operator!=(const QNetworkProxyQuery &other) const
 
-    Returns true if this QNetworkProxyQuery object does not contain
+    Returns \c true if this QNetworkProxyQuery object does not contain
     the same data as \a other.
 */
 
diff --git a/src/network/kernel/qurlinfo.cpp b/src/network/kernel/qurlinfo.cpp
index 89d48639cf..a4200789cd 100644
--- a/src/network/kernel/qurlinfo.cpp
+++ b/src/network/kernel/qurlinfo.cpp
@@ -545,7 +545,7 @@ QDateTime QUrlInfo::lastRead() const
 }
 
 /*!
-    Returns true if the URL is a directory; otherwise returns false.
+    Returns \c true if the URL is a directory; otherwise returns \c false.
 
     \sa isValid()
 */
@@ -558,7 +558,7 @@ bool QUrlInfo::isDir() const
 }
 
 /*!
-    Returns true if the URL is a file; otherwise returns false.
+    Returns \c true if the URL is a file; otherwise returns \c false.
 
     \sa isValid()
 */
@@ -571,7 +571,7 @@ bool QUrlInfo::isFile() const
 }
 
 /*!
-    Returns true if the URL is a symbolic link; otherwise returns false.
+    Returns \c true if the URL is a symbolic link; otherwise returns \c false.
 
     \sa isValid()
 */
@@ -584,7 +584,7 @@ bool QUrlInfo::isSymLink() const
 }
 
 /*!
-    Returns true if the URL is writable; otherwise returns false.
+    Returns \c true if the URL is writable; otherwise returns \c false.
 
     \sa isValid()
 */
@@ -597,7 +597,7 @@ bool QUrlInfo::isWritable() const
 }
 
 /*!
-    Returns true if the URL is readable; otherwise returns false.
+    Returns \c true if the URL is readable; otherwise returns \c false.
 
     \sa isValid()
 */
@@ -610,7 +610,7 @@ bool QUrlInfo::isReadable() const
 }
 
 /*!
-    Returns true if the URL is executable; otherwise returns false.
+    Returns \c true if the URL is executable; otherwise returns \c false.
 
     \sa isValid()
 */
@@ -623,7 +623,7 @@ bool QUrlInfo::isExecutable() const
 }
 
 /*!
-    Returns true if \a i1 is greater than \a i2; otherwise returns
+    Returns \c true if \a i1 is greater than \a i2; otherwise returns
     false. The objects are compared by the value, which is specified
     by \a sortBy. This must be one of QDir::Name, QDir::Time or
     QDir::Size.
@@ -645,7 +645,7 @@ bool QUrlInfo::greaterThan(const QUrlInfo &i1, const QUrlInfo &i2,
 }
 
 /*!
-    Returns true if \a i1 is less than \a i2; otherwise returns false.
+    Returns \c true if \a i1 is less than \a i2; otherwise returns \c false.
     The objects are compared by the value, which is specified by \a
     sortBy. This must be one of QDir::Name, QDir::Time or QDir::Size.
 */
@@ -657,7 +657,7 @@ bool QUrlInfo::lessThan(const QUrlInfo &i1, const QUrlInfo &i2,
 }
 
 /*!
-    Returns true if \a i1 equals to \a i2; otherwise returns false.
+    Returns \c true if \a i1 equals to \a i2; otherwise returns \c false.
     The objects are compared by the value, which is specified by \a
     sortBy. This must be one of QDir::Name, QDir::Time or QDir::Size.
 */
@@ -678,8 +678,8 @@ bool QUrlInfo::equal(const QUrlInfo &i1, const QUrlInfo &i2,
 }
 
 /*!
-    Returns true if this QUrlInfo is equal to \a other; otherwise
-    returns false.
+    Returns \c true if this QUrlInfo is equal to \a other; otherwise
+    returns \c false.
 
     \sa lessThan(), equal()
 */
@@ -710,14 +710,14 @@ bool QUrlInfo::operator==(const QUrlInfo &other) const
     \fn bool QUrlInfo::operator!=(const QUrlInfo &other) const
     \since 4.2
 
-    Returns true if this QUrlInfo is not equal to \a other; otherwise
-    returns false.
+    Returns \c true if this QUrlInfo is not equal to \a other; otherwise
+    returns \c false.
 
     \sa lessThan(), equal()
 */
 
 /*!
-    Returns true if the URL info is valid; otherwise returns false.
+    Returns \c true if the URL info is valid; otherwise returns \c false.
     Valid means that the QUrlInfo contains real information.
 
     You should always check if the URL info is valid before relying on