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>

13 files changed, 37 insertions, 37 deletions

diff --git a/src/network/access/qabstractnetworkcache.cpp b/src/network/access/qabstractnetworkcache.cpp
index 69e0d26a0e..01a5d5d4e1 100644
--- a/src/network/access/qabstractnetworkcache.cpp
+++ b/src/network/access/qabstractnetworkcache.cpp
@@ -158,7 +158,7 @@ QNetworkCacheMetaData &QNetworkCacheMetaData::operator=(const QNetworkCacheMetaD
  */
 
 /*!
-    Returns true if this meta data is equal to the \a other meta data; otherwise returns false.
+    Returns \c true if this meta data is equal to the \a other meta data; otherwise returns \c false.
 
     \sa operator!=()
  */
@@ -174,13 +174,13 @@ bool QNetworkCacheMetaData::operator==(const QNetworkCacheMetaData &other) const
 /*!
     \fn bool QNetworkCacheMetaData::operator!=(const QNetworkCacheMetaData &other) const
 
-    Returns true if this meta data is not equal to the \a other meta data; otherwise returns false.
+    Returns \c true if this meta data is not equal to the \a other meta data; otherwise returns \c false.
 
     \sa operator==()
  */
 
 /*!
-    Returns true if this network cache meta data has attributes that have been set otherwise false.
+    Returns \c true if this network cache meta data has attributes that have been set otherwise false.
  */
 bool QNetworkCacheMetaData::isValid() const
 {
diff --git a/src/network/access/qftp.cpp b/src/network/access/qftp.cpp
index a77e1a643c..3b0d0deeb9 100644
--- a/src/network/access/qftp.cpp
+++ b/src/network/access/qftp.cpp
@@ -831,8 +831,8 @@ void QFtpPI::connectToHost(const QString &host, quint16 port)
   are all done the finished() signal is emitted. When an error occurs, the
   error() signal is emitted.
 
-  If there are pending commands in the queue this functions returns false and
-  the \a cmds are not added to the queue; otherwise it returns true.
+  If there are pending commands in the queue this functions returns \c false and
+  the \a cmds are not added to the queue; otherwise it returns \c true.
 */
 bool QFtpPI::sendCommands(const QStringList &cmds)
 {
@@ -987,7 +987,7 @@ void QFtpPI::readyRead()
 
   Process a reply from the FTP server.
 
-  Returns true if the reply was processed or false if the reply has to be
+  Returns \c true if the reply was processed or false if the reply has to be
   processed at a later point.
 */
 bool QFtpPI::processReply()
@@ -1159,8 +1159,8 @@ bool QFtpPI::processReply()
 /*
   \internal
 
-  Starts next pending command. Returns false if there are no pending commands,
-  otherwise it returns true.
+  Starts next pending command. Returns \c false if there are no pending commands,
+  otherwise it returns \c true.
 */
 bool QFtpPI::startNextCmd()
 {
@@ -2164,8 +2164,8 @@ QIODevice* QFtp::currentDevice() const
 
 /*!
     \internal
-    Returns true if there are any commands scheduled that have not yet
-    been executed; otherwise returns false.
+    Returns \c true if there are any commands scheduled that have not yet
+    been executed; otherwise returns \c false.
 
     The command that is being executed is \e not considered as a
     scheduled command.
diff --git a/src/network/access/qhttpmultipart.cpp b/src/network/access/qhttpmultipart.cpp
index 5985ed94e0..20860b0fc9 100644
--- a/src/network/access/qhttpmultipart.cpp
+++ b/src/network/access/qhttpmultipart.cpp
@@ -134,7 +134,7 @@ QHttpPart &QHttpPart::operator=(const QHttpPart &other)
 */
 
 /*!
-    Returns true if this object is the same as \a other (i.e., if they
+    Returns \c true if this object is the same as \a other (i.e., if they
     have the same headers and body).
 
     \sa operator!=()
@@ -147,7 +147,7 @@ bool QHttpPart::operator==(const QHttpPart &other) const
 /*!
     \fn bool QHttpPart::operator!=(const QHttpPart &other) const
 
-    Returns true if this object is not the same as \a other.
+    Returns \c true if this object is not the same as \a other.
 
     \sa operator==()
 */
diff --git a/src/network/access/qnetworkaccessbackend.cpp b/src/network/access/qnetworkaccessbackend.cpp
index 47cd928541..3c5e1e80a8 100644
--- a/src/network/access/qnetworkaccessbackend.cpp
+++ b/src/network/access/qnetworkaccessbackend.cpp
@@ -374,7 +374,7 @@ void QNetworkAccessBackend::sslErrors(const QList<QSslError> &errors)
 }
 
 /*!
-    Starts the backend.  Returns true if the backend is started.  Returns false if the backend
+    Starts the backend.  Returns \c true if the backend is started.  Returns \c false if the backend
     could not be started due to an unopened or roaming session.  The caller should recall this
     function once the session has been opened or the roaming process has finished.
 */
diff --git a/src/network/access/qnetworkaccessbackend_p.h b/src/network/access/qnetworkaccessbackend_p.h
index d9657cf750..dd033e805b 100644
--- a/src/network/access/qnetworkaccessbackend_p.h
+++ b/src/network/access/qnetworkaccessbackend_p.h
@@ -163,7 +163,7 @@ public:
     // This will possibly enable buffering of the upload data.
     virtual bool needsResetableUploadData() { return false; }
 
-    // Returns true if backend is able to resume downloads.
+    // Returns \c true if backend is able to resume downloads.
     virtual bool canResume() const { return false; }
     virtual void setResumeOffset(quint64 offset) { Q_UNUSED(offset); }
 
diff --git a/src/network/access/qnetworkaccesscache.cpp b/src/network/access/qnetworkaccesscache.cpp
index 4284cb4565..8ee2c3ef27 100644
--- a/src/network/access/qnetworkaccesscache.cpp
+++ b/src/network/access/qnetworkaccesscache.cpp
@@ -165,7 +165,7 @@ void QNetworkAccessCache::linkEntry(const QByteArray &key)
 
 /*!
     Removes the entry pointed by \a key from the linked list.
-    Returns true if the entry removed was the oldest one.
+    Returns \c true if the entry removed was the oldest one.
  */
 bool QNetworkAccessCache::unlinkEntry(const QByteArray &key)
 {
diff --git a/src/network/access/qnetworkcookie.cpp b/src/network/access/qnetworkcookie.cpp
index a40a28b03f..a871c04d56 100644
--- a/src/network/access/qnetworkcookie.cpp
+++ b/src/network/access/qnetworkcookie.cpp
@@ -155,15 +155,15 @@ QNetworkCookie &QNetworkCookie::operator=(const QNetworkCookie &other)
 /*!
     \fn bool QNetworkCookie::operator!=(const QNetworkCookie &other) const
 
-    Returns true if this cookie is not equal to \a other.
+    Returns \c true if this cookie is not equal to \a other.
 
     \sa operator==()
 */
 
 /*!
     \since 5.0
-    Returns true if this cookie is equal to \a other. This function
-    only returns true if all fields of the cookie are the same.
+    Returns \c true if this cookie is equal to \a other. This function
+    only returns \c true if all fields of the cookie are the same.
 
     However, in some contexts, two cookies of the same name could be
     considered equal.
@@ -184,7 +184,7 @@ bool QNetworkCookie::operator==(const QNetworkCookie &other) const
 }
 
 /*!
-    Returns true if this cookie has the same identifier tuple as \a other.
+    Returns \c true if this cookie has the same identifier tuple as \a other.
     The identifier tuple is composed of the name, domain and path.
 
     \sa operator==()
@@ -195,7 +195,7 @@ bool QNetworkCookie::hasSameIdentifier(const QNetworkCookie &other) const
 }
 
 /*!
-    Returns true if the "secure" option was specified in the cookie
+    Returns \c true if the "secure" option was specified in the cookie
     string, false otherwise.
 
     Secure cookies may contain private information and should not be
@@ -224,7 +224,7 @@ void QNetworkCookie::setSecure(bool enable)
 /*!
     \since 4.5
 
-    Returns true if the "HttpOnly" flag is enabled for this cookie.
+    Returns \c true if the "HttpOnly" flag is enabled for this cookie.
 
     A cookie that is "HttpOnly" is only set and retrieved by the
     network requests and replies; i.e., the HTTP protocol. It is not
@@ -248,7 +248,7 @@ void QNetworkCookie::setHttpOnly(bool enable)
 }
 
 /*!
-    Returns true if this cookie is a session cookie. A session cookie
+    Returns \c true if this cookie is a session cookie. A session cookie
     is a cookie which has no expiration date, which means it should be
     discarded when the application's concept of session is over
     (usually, when the application exits).
diff --git a/src/network/access/qnetworkcookiejar.cpp b/src/network/access/qnetworkcookiejar.cpp
index b9e7c36149..d6a5986271 100644
--- a/src/network/access/qnetworkcookiejar.cpp
+++ b/src/network/access/qnetworkcookiejar.cpp
@@ -169,7 +169,7 @@ static inline bool isParentDomain(QString domain, QString reference)
     Adds the cookies in the list \a cookieList to this cookie
     jar. Before being inserted cookies are normalized.
 
-    Returns true if one or more cookies are set for \a url,
+    Returns \c true if one or more cookies are set for \a url,
     otherwise false.
 
     If a cookie already exists in the cookie jar, it will be
@@ -265,7 +265,7 @@ QList<QNetworkCookie> QNetworkCookieJar::cookiesForUrl(const QUrl &url) const
     \since 5.0
     Adds \a cookie to this cookie jar.
 
-    Returns true if \a cookie was added, false otherwise.
+    Returns \c true if \a cookie was added, false otherwise.
 
     If a cookie with the same identifier already exists in the
     cookie jar, it will be overridden.
@@ -291,7 +291,7 @@ bool QNetworkCookieJar::insertCookie(const QNetworkCookie &cookie)
     If a cookie with the same identifier as \a cookie exists in this cookie jar
     it will be updated. This function uses insertCookie().
 
-    Returns true if \a cookie was updated, false if no cookie in the jar matches
+    Returns \c true if \a cookie was updated, false if no cookie in the jar matches
     the identifier of \a cookie.
 
     \sa QNetworkCookie::hasSameIdentifier()
@@ -307,7 +307,7 @@ bool QNetworkCookieJar::updateCookie(const QNetworkCookie &cookie)
     \since 5.0
     Deletes from cookie jar the cookie found to have the same identifier as \a cookie.
 
-    Returns true if a cookie was deleted, false otherwise.
+    Returns \c true if a cookie was deleted, false otherwise.
 
     \sa QNetworkCookie::hasSameIdentifier()
 */
@@ -325,7 +325,7 @@ bool QNetworkCookieJar::deleteCookie(const QNetworkCookie &cookie)
 
 /*!
     \since 5.0
-    Returns true if the domain and path of \a cookie are valid, false otherwise.
+    Returns \c true if the domain and path of \a cookie are valid, false otherwise.
     The \a url parameter is used to determine if the domain specified in the cookie
     is allowed.
 */
diff --git a/src/network/access/qnetworkdiskcache.cpp b/src/network/access/qnetworkdiskcache.cpp
index 064f87c2c0..d64d697013 100644
--- a/src/network/access/qnetworkdiskcache.cpp
+++ b/src/network/access/qnetworkdiskcache.cpp
@@ -685,7 +685,7 @@ void QCacheItem::writeCompressedData(QFile *device) const
 }
 
 /*!
-    Returns false if the file is a cache file,
+    Returns \c false if the file is a cache file,
     but is an older version and should be removed otherwise true.
  */
 bool QCacheItem::read(QFile *device, bool readData)
diff --git a/src/network/access/qnetworkreply.cpp b/src/network/access/qnetworkreply.cpp
index dc42adc612..ba6f706f7a 100644
--- a/src/network/access/qnetworkreply.cpp
+++ b/src/network/access/qnetworkreply.cpp
@@ -490,7 +490,7 @@ QNetworkReply::NetworkError QNetworkReply::error() const
 /*!
     \since 4.6
 
-    Returns true when the reply has finished or was aborted.
+    Returns \c true when the reply has finished or was aborted.
 
     \sa isRunning()
 */
@@ -502,7 +502,7 @@ bool QNetworkReply::isFinished() const
 /*!
     \since 4.6
 
-    Returns true when the request is still processing and the
+    Returns \c true when the request is still processing and the
     reply has not finished or was aborted yet.
 
     \sa isFinished()
@@ -536,7 +536,7 @@ QVariant QNetworkReply::header(QNetworkRequest::KnownHeaders header) const
 }
 
 /*!
-    Returns true if the raw header of name \a headerName was sent by
+    Returns \c true if the raw header of name \a headerName was sent by
     the remote server
 
     \sa rawHeader()
diff --git a/src/network/access/qnetworkreplyhttpimpl.cpp b/src/network/access/qnetworkreplyhttpimpl.cpp
index ddef970966..29d23bfd8f 100644
--- a/src/network/access/qnetworkreplyhttpimpl.cpp
+++ b/src/network/access/qnetworkreplyhttpimpl.cpp
@@ -1521,7 +1521,7 @@ void QNetworkReplyHttpImplPrivate::setResumeOffset(quint64 offset)
 }
 
 /*!
-    Starts the backend.  Returns true if the backend is started.  Returns false if the backend
+    Starts the backend.  Returns \c true if the backend is started.  Returns \c false if the backend
     could not be started due to an unopened or roaming session.  The caller should recall this
     function once the session has been opened or the roaming process has finished.
 */
@@ -1961,7 +1961,7 @@ void QNetworkReplyHttpImplPrivate::metaDataChanged()
 
 /*
     Migrates the backend of the QNetworkReply to a new network connection if required.  Returns
-    true if the reply is migrated or it is not required; otherwise returns false.
+    true if the reply is migrated or it is not required; otherwise returns \c false.
 */
 bool QNetworkReplyHttpImplPrivate::migrateBackend()
 {
diff --git a/src/network/access/qnetworkreplyimpl.cpp b/src/network/access/qnetworkreplyimpl.cpp
index 33357293a3..f51b85cba0 100644
--- a/src/network/access/qnetworkreplyimpl.cpp
+++ b/src/network/access/qnetworkreplyimpl.cpp
@@ -1079,7 +1079,7 @@ bool QNetworkReplyImpl::event(QEvent *e)
 
 /*
     Migrates the backend of the QNetworkReply to a new network connection if required.  Returns
-    true if the reply is migrated or it is not required; otherwise returns false.
+    true if the reply is migrated or it is not required; otherwise returns \c false.
 */
 bool QNetworkReplyImplPrivate::migrateBackend()
 {
diff --git a/src/network/access/qnetworkrequest.cpp b/src/network/access/qnetworkrequest.cpp
index 00d5b81413..65fd693771 100644
--- a/src/network/access/qnetworkrequest.cpp
+++ b/src/network/access/qnetworkrequest.cpp
@@ -369,7 +369,7 @@ QNetworkRequest::~QNetworkRequest()
 }
 
 /*!
-    Returns true if this object is the same as \a other (i.e., if they
+    Returns \c true if this object is the same as \a other (i.e., if they
     have the same URL, same headers and same meta-data settings).
 
     \sa operator!=()
@@ -382,7 +382,7 @@ bool QNetworkRequest::operator==(const QNetworkRequest &other) const
 /*!
     \fn bool QNetworkRequest::operator!=(const QNetworkRequest &other) const
 
-    Returns false if this object is not the same as \a other.
+    Returns \c false if this object is not the same as \a other.
 
     \sa operator==()
 */
@@ -449,7 +449,7 @@ void QNetworkRequest::setHeader(KnownHeaders header, const QVariant &value)
 }
 
 /*!
-    Returns true if the raw header \a headerName is present in this
+    Returns \c true if the raw header \a headerName is present in this
     network request.
 
     \sa rawHeader(), setRawHeader()